adding packaging information in the readme
This commit is contained in:
parent
c13ff1643c
commit
f258d24007
29
README.txt
29
README.txt
@ -58,4 +58,31 @@ Work in progress :)
|
||||
# Requirements
|
||||
|
||||
* pillow
|
||||
* pyhyphen
|
||||
|
||||
# Release (PyPi package building)
|
||||
|
||||
<https://python-packaging-tutorial.readthedocs.io/en/latest/setup_py.html>
|
||||
|
||||
Make the pip wheel:
|
||||
|
||||
`$ python3 setup.py bdist_wheel`
|
||||
|
||||
Upload the package to pypi:
|
||||
|
||||
`$ twine upload dist/*`
|
||||
|
||||
For the last step, you need to install Twine (<https://packaging.python.org/key_projects/#twine>):
|
||||
|
||||
`$ pip install twine`
|
||||
|
||||
# Develop the asciiWriter
|
||||
|
||||
Make a virtualenv:
|
||||
|
||||
`$ python3 -m venv venvname`
|
||||
|
||||
Install asciiWriter in (editable) development mode:
|
||||
|
||||
`$ pip install -e ./`
|
||||
|
||||
Now you can work with the asciiWriter and the code will be updated when you make changes!
|
Loading…
Reference in New Issue
Block a user