Skip to content

Commit

Permalink
Installation instructions for developers
Browse files Browse the repository at this point in the history
  • Loading branch information
nikuda committed Dec 2, 2017
1 parent 01f4801 commit e9217a9
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,37 @@ If the game has a non-Wikipedia link:
name: [Name, 'http://www.example.com']
```
## Contributing
### Pre-requisites
* [Python 2][python]
* [virtualenv][virtualenv]
### Install
Clone this repository and run inside the directory:
```
virtualenv .env
source .env/bin/activate
make install
```
### Building

Make sure the virtual env is active, if not run:

```
source .env/bin/activate
```

Then simply run the following to build the project into the `_build` directory.

```
make
```

## License

See [LICENSE][license]
Expand All @@ -86,3 +117,6 @@ See [LICENSE][license]
[schema_originals]: schema/originals.yaml
[template]: .github/ISSUE_TEMPLATE.md
[license]: LICENSE

[python]: https://www.python.org
[virtualenv]: https://virtualenv.pypa.io

0 comments on commit e9217a9

Please sign in to comment.