Commit 71a2d725 authored by Lucas Amoudruz's avatar Lucas Amoudruz
Browse files

doc about doc

parent 55af4da1
= doc
= Documentation
:lext: .adoc
Requires `asciidoctor` and `pygments.rb`.
The `uDeviceX` documentation is written in `Asciidoc` format and converted to `html`.
This operation requires link:https://asciidoctor.org/[asciidoctor] (converter to html) and
link:http://pygments.org/[pygments.rb] (for code highlighting).
== installation
=== Mac OS X
== Mac OS X
[source,sh]
----
gem install asciidoctor
gem install pygments.rb
----
== Arch linux
=== Arch linux
[source,sh]
----
sudo pacman -S asciidoctor
gem install pygments.rb
----
== build
When writing documentation, it is useful to build it and view it on a
local server.
From `doc/`:
[source, sh]
----
./tools/start # <1>
./tools/view # <2>
./tools/stop # <3>
----
<1> start a local server (to be done only once)
<2> open the main page in browser from local server
<3> stop the local server
[source, sh]
----
./configure # <1>
make -j # <2>
----
<1> make dependencies (to be run after adding a file to documentation)
<2> build documentation for local server
== Deploy
The deploy command cleans, builds and pushes the documentation on github pages https://github.com/amlucas/udoc
[source, sh]
----
./deploy
----
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment