Zerocat Label  v0.1.6
General Documentation for the Zerocat Label.
README

Main Page | Related Pages | List of Files

About

The Zerocat Label is meant as an umbrella for true free-design hardware projects and related stuff. Zerocat projects...

  • come with Free Documentation.
  • run with Free Software.
  • have a free-design board layout.
  • use Free-Design Microcontrollers.
  • aim to be Do-it-Yourself projects.

This documentation applies to Zerocat Projects in general as well as to the Zerocat Label itself.

Internet Resources

Website

Please see the website of the Zerocat Label to stay tuned.

Shop

We are offering products and services in Berlin (Germany), as for example:

  • The Zerocat Chipflasher
  • Free Software Laptops, coreboot preflashed, GNU/Linux-libre preinstalled
  • Flash Services for coreboot and libreboot compatible devices
  • Parallax Propeller Microcontrollers in DIL40 and LQFP44 Packages (in case you need one for your DIY-project)
  • and more...

Please check our current portfolio and prices at the Zerocat Shop.
Key products and their box accompanying documents are listed in Zerocat Products.

Email

Please send your questions, feedback, bug reports or product requests to zerocat@posteo.de. A public OpenPGP key is available upon request.

Mailing List

The Zerocat Label is using encrypted email for its mailing list; currently, we don’t have a general address for it. If you want to contact the ML, please write an email to zerocat@posteo.de and your mail will be forwarded.

Git Repository

This documentation is publically available like so:

git://zerocat.org/zerocat/projects/doc

Prerequisites

GNU/Linux OS

We assume that you are running a GNU/Linux-libre Operating System like Trisquel, for example.

Very essential tools that allow building this documentation should be installed first, as like...

Clone the Repository

As a next step, please open a terminal, create a zerocat project folder and clone the public git repository onto your harddrive:

$ mkdir -p ~/zerocat/projects/
$ cd ~/zerocat/projects/
$ git clone git://zerocat.org/zerocat/projects/doc

Now you have a folder ~/zerocat/projects/ with subfolder doc/.

External Software Tools

Please see Zerocat Tools for a detailed list of useful software tools. You should install these tools before you proceed with other projects.

Generate the Zerocat Documentation

Change into doc/ and build the html documentation:

$ cd ~/zerocat/projects/doc/doc/
$ make

In the ~/zerocat/projects/doc/doc/ folder, now you have a html tree available:

  • Zerocat Documentation: zerocat-documentation/html/index.html

Where to Go?

Open the index.html of the Zerocat Documentation in your browser. You will see the Main Page which guides you to this README and other files.

Licenses

The files that ship with the Zerocat Label fall into five categories:

  1. hardware design sources (files from LibreCAD, OpenSCAD, gEDA-gschem, PCB, etc.)
  2. code sources (text files with syntax of C, ASM, Makefile, Propeller-Load Configuration, Doxyfile, bash, scheme, etc.)
  3. documentation files (markdown, simple text)
  4. graphics and photos (files made with Inkscape, Gimp, etc.)
  5. logo files (files made with Scribus, Inkscape, Gimp, etc.)

In general the following rules apply:

  • A license header is placed within the files if applicable.
  • "1. hardware design sources" and "2. code sources" are licensed under the GNU GPLv3 or later. The license itself is shipped as COPYING.
  • "3. documentation files" are licensed under GNU FDL 1.3 or later, without invariant sections, front-cover texts or back-cover texts. This license is shipped with COPYING-DOCUMENTATION.
  • "4. graphics and photos" are released under the CC BY-SA 4.0 International Public License. The URL to the license text is shipped with COPYING-GRAPHICS.
  • "5. logo files" are released under the Zerocat Logo License. This license is shipped with COPYING-LOGO.

Development

Free System Distribution Guidelines (GNU FSDG)

We check the Zerocat Label and its project distributions according to the GNU FSDG.
If you discover mistakes, please report to zerocat@posteo.de and we will fix them.

Main Page | Related Pages | List of Files