mirror of
https://gitlab.com/SIGBUS/nyaa.git
synced 2024-12-22 10:00:01 +00:00
Update README.md
Add Travis build status badge, move running tests next to code quality
This commit is contained in:
parent
6f526de5ea
commit
e8e8c27994
12
README.md
12
README.md
|
@ -1,4 +1,4 @@
|
|||
# NyaaV2
|
||||
# NyaaV2 [![Build Status](https://travis-ci.org/nyaadevs/nyaa.svg?branch=master)](https://travis-ci.org/nyaadevs/nyaa)
|
||||
|
||||
## Setting up for development
|
||||
This project uses Python 3.6. There are features used that do not exist in 3.5, so make sure to use Python 3.6.
|
||||
|
@ -10,6 +10,11 @@ It's not impossible to run Nyaa on Windows, but this guide doesn't focus on that
|
|||
- You may also use `./lint.sh -c` to see a list of warnings/problems instead of having `lint.sh` making modifications for you
|
||||
- Other than PEP8, try to keep your code clean and easy to understand, as well. It's only polite!
|
||||
|
||||
### Running Tests
|
||||
We have some basic tests that check if each page can render correctly. To run the tests:
|
||||
- Make sure that you are in the python virtual environment.
|
||||
- Run `python -m pytest tests/` while in the repository directory.
|
||||
|
||||
### Setting up Pyenv
|
||||
pyenv eases the use of different Python versions, and as not all Linux distros offer 3.6 packages, it's right up our alley.
|
||||
- Install dependencies https://github.com/pyenv/pyenv/wiki/Common-build-problems
|
||||
|
@ -108,8 +113,3 @@ However, take note that binglog is not necessary for simple ES testing and devel
|
|||
|
||||
You're done! The script should now be feeding updates from the database to Elasticsearch.
|
||||
Take note, however, that the specified ES index refresh interval is 30 seconds, which may feel like a long time on local development. Feel free to adjust it or [poke Elasticsearch yourself!](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-refresh.html)
|
||||
|
||||
### Running Tests
|
||||
We have some basic tests that check if each page can render correctly. To run the tests:
|
||||
- Make sure that you are in the python virtual environment.
|
||||
- Run `python -m pytest tests/` while in the repository directory.
|
||||
|
|
Loading…
Reference in a new issue