mirror of
https://github.com/ProjectSynthoria/SynthoriaArchive.git
synced 2025-03-12 07:26:54 +02:00
Update README.md
This commit is contained in:
parent
6102316052
commit
a9f18fafd4
1 changed files with 4 additions and 4 deletions
|
@ -1,4 +1,4 @@
|
|||
# NyaaV3 [](https://www.python.org) 
|
||||
# NyaaV3 [](https://www.python.org) 
|
||||
|
||||
## Setting up for development
|
||||
This project uses Python 3.13. The codebase has been updated from the original Python 3.7 version to use modern Python features and updated dependencies.
|
||||
|
@ -12,12 +12,12 @@ Running Nyaa on Windows may be possible, but it's currently unsupported.
|
|||
- Replaced deprecated Flask-Script, orderedset and `flask.Markup` with Flask CLI, orderly-set and markupsafe
|
||||
- Implemented mail error handling
|
||||
|
||||
### Code Quality:
|
||||
### Code Quality
|
||||
- Before we get any deeper, remember to follow PEP8 style guidelines and run `python dev.py lint` before committing to see a list of warnings/problems.
|
||||
- You may also use `python dev.py fix && python dev.py isort` to automatically fix some of the issues reported by the previous command.
|
||||
- Other than PEP8, try to keep your code clean and easy to understand, as well. It's only polite!
|
||||
|
||||
### Running Tests
|
||||
### Running tests
|
||||
The `tests` folder contains tests for the the `nyaa` module and the webserver. To run the tests:
|
||||
- Make sure that you are in the Python virtual environment.
|
||||
- Run `python dev.py test` while in the repository directory.
|
||||
|
@ -135,4 +135,4 @@ By using this software, you're agreeing to a few things:
|
|||
- I'm not responsible for any legal issues that might come up from using this tracker, especially if it's used to share copyrighted content without permission.
|
||||
- It's your responsibility to make sure you're following the laws in your area when using this software.
|
||||
|
||||
**Please use this project wisely and stay on the right side of the law.** Happy coding!
|
||||
**Please use this project wisely and stay on the right side of the law.** Happy coding!
|
||||
|
|
Loading…
Add table
Reference in a new issue