• This repository has been archived on 04/Aug/2019
  • Stars
    star
    6
  • Rank 2,488,028 (Top 50 %)
  • Language
    TeX
  • License
    Creative Commons ...
  • Created over 6 years ago
  • Updated almost 5 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Community driven tutorial for CIlib

Note:

This project will be folded into the main project repository and will preferably be served online.

Community tutorial for CIlib

Build Status

Welcome to the community tutorial source repository!

About the tutorial

The tutorial is a community project detailing the use of the CIlib library, and the explanation of some of the concepts that are used within the library.

Building the sources and contributions

PRs are welcome! All changes will be be reviewed before inclusion, but the review process will be transparent and open.

To build the project, you can either install the needed software on your local machine, or you can use the docker baced build process.

The book uses the build tool developed by underscore.io to convert markdown sources into a final PDF (through the use of Pandoc and LaTeX)

You'll need to have docker (>= 1.8.0) installed (and by extension have docker-compose available) locally and be familiar with how docker operates.

To build the documentation, please use the build.sh script (or use the relevant docker commands manually, if preferred) which will build the sources, and also start needed containers.

Please remember to run docker-compose down when you are done!