Skip to content

Commit 94b96b3

Browse files
committed
update readme for how to setup for development
1 parent c3bdeed commit 94b96b3

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,34 @@ This mimics the behavior of how MkDocs builds the site dir without this plugin.
5555
## Contributing
5656

5757
- Pull Requests are welcome.
58+
- Make sure to update CHANGES.md
5859
- File bugs and suggestions in the [GitHub Issues tracker](https://github.com/datarobot/mkdocs-redirects/issues).
5960

61+
## Developing
62+
63+
### Setup a virtualenv
64+
65+
Create a virtualenv using a method of your choice.
66+
67+
```bash
68+
brew install pyenv pyenv-virtualenv
69+
pyenv install 2.7.18
70+
pyenv virtualenv 2.7.18 mkdocs-redirects
71+
pyenv activate mkdocs-redirects
72+
```
73+
74+
### Build
75+
76+
```bash
77+
make build
78+
```
79+
80+
### Test
81+
82+
```bash
83+
make test
84+
```
85+
6086
## Releasing
6187

6288
```bash

0 commit comments

Comments
 (0)