Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
ci
 
 
cli
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

LibrePCB Documentation

Travis Build Status

This repository contains the source for the LibrePCB documentation hosted at docs.librepcb.org.

Requirements

The documentation is written in Asciidoc and built with Asciidoctor.

On Linux the required tools can be installed with following commands:

gem install asciidoctor pygments.rb rouge
gem install asciidoctor-pdf --pre

On Mac you can use homebrew and install gems in your user folder:

brew install asciidoctor
gem install --user-install pygments.rb rouge

This will keep your installation more resilient to OS X upgrades.

Building

asciidoctor index.adoc          # build index.html
asciidoctor-pdf index.adoc      # build index.pdf

Contributing

Contributions are very welcome! See our Contributing Guide for details. We're looking forward for pull requests :)

Links

License

This documentation is published under the CC0 1.0 Universal license.