Logo

Zerocat Project Template – Make something exciting!

AUTHORS.md

AUTHORS
=======


* Kai Mertens (See source file for contact information.)


___

(See source file for copyright information.)
    

COPYING.md

Copying
=======


Zerocat Project Template ships copyrighted work.  
See [AUTHORS][] for a list of people which have contributed.

Zerocat Project Template is free software. It makes use of free software
approved licenses only and should be freely distributable:

* [GNU General Public License][GNU GPL]
* [GNU Free Documentation License][GNU FDL]
* [CreativeCommons Attribution-ShareAlike License][CC BY-SA]

Authorship, copyright and license information may be provided in more 
detail on a per-folder and/or per-file basis. Check the sources.

Please report a bug if you find the distribution hindered by any
obstacle. See [Zerocat Website][] for contact information.


___

[AUTHORS]:                ../doc/AUTHORS.md
[GNU-GPL]:                ../doc/GNU-GPL.md
[GNU-FDL]:                ../doc/GNU-FDL.md
[CC BY-SA]:               https://creativecommons.org/licenses/by-sa/4.0/
[Zerocat Website]:        http://www.zerocat.org/


___

(See source file for copyright information.)
    

README.md

README
======


Project Goal
------------


The goal of Zerocat Project Template is to provide you with a project
skeleton that you can use to set up a new Zerocat project like so:

* Copy this project content into your new, local project folder.

* Perform an initial [Git][] commit.

  (Note an initial commit cannot be accessed by a git rebase action.)

* Update all files in `doc/` to use your new project name and new
  project brief, if applicable.

* Update settings in `doc/Makefile`, e.g.: `PROJECT_TITLE`,
  `PROJECT_BRIEF`, `PROJECT_REPO`

* Update this section with a new goal, related to free-design hardware
  development.

* Update [AUTHORS][].

* Get in contact with [Zerocat Team][] and ask them for setting up an
  empty git repository so that you can push.


Paths
-----


All paths within this document are relative in respect to the original
location of this source file, which is located in the project’s `doc/`
folder.


Prerequisites
-------------


If you are on GNU Guix System, create your environment:

        guix environment --pure -m ../guix/manifest.scm

Otherwise, check the manifest file and install the listed packages with
the package manager of your distro. Adapt package names as required.


Make Documentation
------------------


To build the documentation, type:

        make -C ../doc

To get a full list of available targets, type:

        make -C ../doc help


Contributing
------------


Once you have contributed, add yourself to [AUTHORS][].


### Documentation Files


In order to enrich this documentation:

* add more `*.md` markdown text files to `../doc/`
* maintain copyright footer within new files
* add more folders, images or other files

... and adapt `../doc/Makefile` to produce nice output.

In case more tools are needed, don't forget to update
`../guix/manifest.scm`.


### Shell Scripts


If you intend to write shell scripts, use this skeleton to make them
work for GNU Guix:

        #!/bin/sh

        # Re-exec if we are not using Bash or are using Bash in POSIX mode.
        if [ -z "$BASH" ] || [ "$BASH" = "/bin/sh" ]; then
          bash=`command -v bash`
          if [ -z "$bash" ]; then
            echo "Couldn't find Bash, sorry!"
            exit 1
          else
            exec "$bash" "$0" "$@"
          fi
        fi

        # We're using Bash now.
        set -o errexit
        set -o nounset
        set -o pipefail

        # Your code goes here ...


### Code Files


This project may ship non-code, graphic sources, which cannot be
covered by the standard GNU General Public License. The license header
for code source files thus has been adapted accordingly, please use it
if you intend to write code:

        Zerocat Project Template --- Make something exciting!

        Copyright (C) 2021  Authors of Zerocat Project Template

        This file is part of Zerocat Project Template.

        This file is free software: you can redistribute it and/or modify it
        under the terms of the GNU General Public License as published by
        the Free Software Foundation, either version 3 of the License,
        or (at your option) any later version.

        This file is distributed in the hope that it will be useful, but
        WITHOUT ANY WARRANTY; without even the implied warranty of
        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
        See the GNU General Public License for more details.

        You should have received a copy of the GNU General Public License
        along with Zerocat Project Template.
        If not, see <http://www.gnu.org/licenses/>.


Version Tags
------------


Within this project’s git repository, versions are tagged according to
the following pattern:

        v<major>.<minor>.<revision>

* major – The resulting product is a major change or upgrade.
* minor – Additional functionality or new features are introduced.
* revision – Bug fixes, minor changes, graphical stuff.


___

[AUTHORS]:        ../doc/AUTHORS.md
[Git]:            https://git-scm.com/
[Zerocat Team]:   http://www.zerocat.org/team.html


___

(See source file for copyright information.)
    

Documentation for “Zerocat Project Template” as of Tue, 12 Oct 2021 21:45:24 +0200
Repository: git://zerocat.org/zerocat/projects/zerocat-project-template
Version: v0.0.8
Branch: master