Skip to content

Commit eac6fa4

Browse files
committed
update docs
1 parent 6ce4d89 commit eac6fa4

2 files changed

Lines changed: 37 additions & 5 deletions

File tree

README.md

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,8 @@ optional arguments:
7474
- [How to run](#how-to-run)
7575
- [Windows](#windows)
7676
- [Linux/ MacOS](#linux-macos)
77+
- [Building](#building)
78+
- [Testing](#testing)
7779
- [Download Project](#download-project)
7880
- [Clone](#clone)
7981
- [Using The Command Line](#using-the-command-line)
@@ -117,8 +119,8 @@ Head to https://pypi.org/project/Waifu2x/ for more info
117119

118120
### Built for
119121

120-
This program has been written for Python versions 3.7 - 3.10 and has been tested with both 3.7 and
121-
3.10
122+
This program has been written for Python versions 3.8 - 3.11 and has been tested with both 3.8 and
123+
3.11
122124

123125
## Install Python on Windows
124126

@@ -178,6 +180,36 @@ version.
178180
- File
179181
`python3.x [file]` or `./[file]`
180182

183+
## Building
184+
185+
This project uses https://github.com/FHPythonUtils/FHMake to automate most of the building. This
186+
command generates the documentation, updates the requirements.txt and builds the library artefacts
187+
188+
Note the functionality provided by fhmake can be approximated by the following
189+
190+
```sh
191+
handsdown --cleanup -o documentation/reference
192+
poetry export -f requirements.txt --output requirements.txt
193+
poetry export -f requirements.txt --with dev --output requirements_optional.txt
194+
poetry build
195+
```
196+
197+
`fhmake audit` can be run to perform additional checks
198+
199+
## Testing
200+
201+
For testing with the version of python used by poetry use
202+
203+
```sh
204+
poetry run pytest
205+
```
206+
207+
Alternatively use `tox` to run tests over python 3.8 - 3.11
208+
209+
```sh
210+
tox
211+
```
212+
181213
## Download Project
182214

183215
### Clone

pyproject.toml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ classifiers = [
1515
"Operating System :: OS Independent",
1616
"Programming Language :: Python :: Implementation :: CPython",
1717
"Topic :: Software Development :: Libraries :: Python Modules",
18-
"Topic :: Utilities"
18+
"Topic :: Utilities",
1919
]
2020
homepage = "https://github.com/FHPythonUtils/waifu2x"
2121
repository = "https://github.com/FHPythonUtils/waifu2x"
@@ -41,7 +41,7 @@ coverage = "^6.3.2"
4141

4242
[tool.black]
4343
line-length = 100
44-
target-version = ["py37"]
44+
target-version = ["py38"]
4545

4646
[tool.isort]
4747
profile = "black"
@@ -66,7 +66,7 @@ argument-rgx = "(([a-z0-9]*_?[a-z0-9]*)*)"
6666
indent-string = "\t"
6767

6868
[tool.pylint.master]
69-
ignore-patterns = "test_.*?py"
69+
ignore-paths = ["tests"]
7070

7171
[tool.pylint.messages_control]
7272
enable = ["F", "E", "W", "R", "C"]

0 commit comments

Comments
 (0)