Skip to content

Commit

Permalink
Fix: readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pylover committed Sep 1, 2024
1 parent 38eba3b commit 08dd195
Showing 1 changed file with 33 additions and 2 deletions.
35 changes: 33 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ you may navigate to desired path before running the `yhttp-markdown` command
or set the `root` configuration entry:

```yaml
# yhttp-markdown configuration file
# settings.yaml
root: path/to/www/root
```
Expand Down Expand Up @@ -269,7 +269,38 @@ See [pygments styles page](https://pygments.org/styles/) to figure out how
they looks like.


## See tests directory
## Contribuition

### Setup development environment

Install [python-makelib](https://github.com/pylover/python-makelib), then:
```bash
cd path/to/yhttp-markdown
make fresh env activate.sh
```

### Test and coverage
```bash
make test
make cover
```

### Lint
```bash
make lint
```


### Serve
```bash
make serve
```

Or
```bash
source activate.sh
yhttp-markdown -C examples serve
```


> **_NOTE:_** Do a `make qa` or `make cover lint` before commit.

0 comments on commit 08dd195

Please sign in to comment.