Logo

Zerocat Artwork – Fancy Artwork for the Zerocat Label

AUTHORS.md

AUTHORS
=======


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


___

(See source file for copyright information.)
    

COPYING.md

Copying
=======


Zerocat Artwork ships copyrighted work.  
See [AUTHORS][] for a list of collected authorship.

Zerocat Artwork 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/


SVG Metadata
------------


SVG files of Zerocat Artwork may have metadata with more information
about authors and copyright. If you are using [Inkscape][], you can
access the document metadata from the file menu or from the document
properties.


[Inkscape]:               https://inkscape.org/


___

(See source file for copyright information.)
    

README.md

README
======


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


Provide a new repository for Zerocat’s logotypes and artwork, this time
with:

* clean commit history
* proper information about authors, copyright and licenses
* SVG source files
* automatic export capabilities
* themed HTML documentation interface
* well maintained list of prerequisites


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 like so:

        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.


Export Images
-------------


In order to automatically export images from corresponding sources,
type:

        make -C ../artwork

This will export images alongside of corresponding source files. Note
this make invocation is a prerequisite for building the documentation,
as some generated images (logo, favicon) will be used for the
documentation itself.

To get a full list of available targets, type:

        make -C ../artwork help


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][].


[AUTHORS]:      ../doc/AUTHORS.md


### 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 ...


### License Header for Code Files


This project may ship with 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, please use it if you
intend to write code:

        Zerocat Artwork --- Fancy Artwork for the Zerocat Label

        Copyright (C) 2021  Authors of Zerocat Artwork

        This file is part of Zerocat Artwork.

        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 Artwork.
        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.


___

(See source file for copyright information.)
    

Documentation for “Zerocat Artwork” as of Sun, 31 Oct 2021 10:44:42 +0100
Repository: git://zerocat.org/zerocat/projects/zerocat-artwork
Version: v0.0.5
Branch: master