Skip to content

Commit

Permalink
docs: add simple explanation on how to develop locally
Browse files Browse the repository at this point in the history
  • Loading branch information
tomootes authored and bfabio committed Nov 26, 2024
1 parent 0c42c47 commit e8030bd
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,24 @@ Furthermore, the project uses branches and tags in the following way:

Feel free to submit [Pull Requests and to file Issues](CONTRIBUTING.md).

The Standard's website (https://yml.publiccode.tools) is built using the Python Sphinx package.

### Prerequisites
- Python 3

### Install dependencies

```console
pip install -r requirements.txt
```

### Local development process
`spinx-build` can be used to compile all source file to static html files. Run this command to generate the website:

```console
sphinx-build docs/standard build -c .
```

## Licence

Licenced under the [CC0-1.0](LICENSE).

0 comments on commit e8030bd

Please sign in to comment.