mirror of https://github.com/status-im/specs.git
add DEVELOPMENT.md doc with build instructions
Signed-off-by: Jakub Sokołowski <jakub@status.im>
This commit is contained in:
parent
064bb3f0ae
commit
3fdb5148f4
|
@ -0,0 +1,38 @@
|
|||
# Description
|
||||
|
||||
This file explains the process of local development for this repository.
|
||||
|
||||
# Dependencies
|
||||
|
||||
This repository is built using [Jekyll](https://jekyllrb.com/) along with some plugins and a theme.
|
||||
|
||||
To install the necessary dependencies on Ubuntu use:
|
||||
```
|
||||
sudo apt-get install ruby-full build-essential zlib1g-dev
|
||||
gem install jekyll bundler
|
||||
```
|
||||
It might be necessary to specify installation destination for your Gems:
|
||||
```
|
||||
export GEM_HOME="$HOME/.gems"
|
||||
export PATH="$HOME/gems/bin:$PATH"
|
||||
```
|
||||
For instructions on other systems use [these docs](https://jekyllrb.com/docs/installation/).
|
||||
|
||||
Then you can install other Gems like the `just-the-docs` theme:
|
||||
```
|
||||
bundle install
|
||||
```
|
||||
|
||||
# Building
|
||||
|
||||
To simply build the site use:
|
||||
```
|
||||
bundle exec jekyll build --config _config_local.yml
|
||||
```
|
||||
This will generate the site files and put them under `_site`.
|
||||
|
||||
But if you want Jekyll to continuously build and also serve the site use:
|
||||
```
|
||||
bundle exec jekyll serve --config _config_local.yml --incremental
|
||||
```
|
||||
This should make it available under http://127.0.0.1:4000/.
|
|
@ -13,6 +13,8 @@ its various capabilities.
|
|||
|
||||
## How to contribute
|
||||
|
||||
You can read about how to build this project [here](./DEVELOPMENT.md).
|
||||
|
||||
1. Create an issue for a new Status Improvement Proposal (SIP) or some bug that you'd like to address
|
||||
2. Create a corresponding PR and ping some existing SIP editors for review
|
||||
|
||||
|
|
Loading…
Reference in New Issue