mirror of
https://github.com/ACINQ/eclair.git
synced 2025-02-25 07:07:24 +01:00
19 lines
852 B
Markdown
19 lines
852 B
Markdown
|
# Eclair documentation man page
|
||
|
|
|
||
|
|
- How to build
|
||
|
|
- How to contribute
|
||
|
|
|
||
|
|
## Building
|
||
|
|
|
||
|
|
The documentation uses [slate](https://github.com/lord/slate) and is hosted via github pages in this repo. To get started you need to download _slate_ in your
|
||
|
|
local machine, you need ruby, ruby-bundle and a few other dependencies. For the complete instructions on how to run slate please refer to its official
|
||
|
|
documentation [here](https://github.com/lord/slate#getting-set-up).
|
||
|
|
|
||
|
|
### Modifying eclair doc
|
||
|
|
|
||
|
|
1. Copy recursively `eclair/docs/slate` into `slate/source` and open a text editor at `slate/source/index.html.md`
|
||
|
|
2. Make your changes
|
||
|
|
3. Run `bundle exec middleman build --clean` as specified by the [instructions](https://github.com/lord/slate/wiki/Deploying-Slate#publishing-your-docs-to-your-own-server)
|
||
|
|
4. Copy the content of `slate/build` into `eclair/docs`
|
||
|
|
|