editing the README
This commit is contained in:
parent
bb134f30c8
commit
27704e8213
@ -1,5 +1,5 @@
|
|||||||
# ASCII-ART-BUT-WITH-UNICODE
|
# ASCII-ART-BUT-WITH-UNICODE
|
||||||
|
|
||||||
<pre>
|
<pre>
|
||||||
---------H---------H---------H---------H---------H---------H---------H---------H---------H---------H
|
---------H---------H---------H---------H---------H---------H---------H---------H---------H---------H
|
||||||
-------------------e------e-------e------e-------e-------e------e-------e------e-------e------------
|
-------------------e------e-------e------e-------e-------e------e-------e------e-------e------------
|
||||||
@ -55,10 +55,9 @@
|
|||||||
|
|
||||||
Work in progress :)
|
Work in progress :)
|
||||||
|
|
||||||
|
|
||||||
# Release (PyPi package building)
|
# Release (PyPi package building)
|
||||||
|
|
||||||
Install Wheel and Twine (<https://packaging.python.org/key_projects/#twine>):
|
Install Wheel and Twine (these are tools to package and upload the release):
|
||||||
|
|
||||||
`$ pip install wheel twine`
|
`$ pip install wheel twine`
|
||||||
|
|
||||||
@ -70,7 +69,6 @@ Upload the package to pypi:
|
|||||||
|
|
||||||
`$ twine upload dist/*`
|
`$ twine upload dist/*`
|
||||||
|
|
||||||
|
|
||||||
# Develop the asciiWriter
|
# Develop the asciiWriter
|
||||||
|
|
||||||
Make a virtualenv:
|
Make a virtualenv:
|
||||||
|
84
README.txt
84
README.txt
@ -1,84 +0,0 @@
|
|||||||
# ASCII-ART-BUT-WITH-UNICODE
|
|
||||||
|
|
||||||
<pre>
|
|
||||||
---------H---------H---------H---------H---------H---------H---------H---------H---------H---------H
|
|
||||||
-------------------e------e-------e------e-------e-------e------e-------e------e-------e------------
|
|
||||||
----------------------------l----l-----l----l----l----l----l-----l----l----l------------------------
|
|
||||||
------------------------------------l---l--l--l--l--l--l--l---l--l----------------------------------
|
|
||||||
-------------------------------------------oo-oo-o-oo-oo-o------------------------------------------
|
|
||||||
----------------------------------------------- ------------------------------------------------
|
|
||||||
-------------------------------------------------W--------------------------------------------------
|
|
||||||
------------------------------------------------ooo-------------------------------------------------
|
|
||||||
---------------------------------------------rrrrrrrrrr---------------------------------------------
|
|
||||||
----------------------------------------l-l-l--l-l-l--l-l-l-l---------------------------------------
|
|
||||||
---------------------------------d---d---d---d---d---d---d---d---d----d-----------------------------
|
|
||||||
------------------------!-----!-----!------!-----!-----!------!-----!-----!------!------------------
|
|
||||||
-------------- -------- -------- ------- -------- -------- ------- -------- -------- -------- ------
|
|
||||||
----H----------H----------H-----------H----------H----------H-----------H----------H----------H-----
|
|
||||||
--------e-------------e------------e-------------e-------------e------------e-------------e---------
|
|
||||||
-l---------------l---------------l---------------l---------------l---------------l---------------l--
|
|
||||||
--------------l----------------l-----------------l-----------------l----------------l---------------
|
|
||||||
-----------o------------------o------------------o------------------o------------------o------------
|
|
||||||
--------- ------------------- ------------------- ------------------- ------------------- ----------
|
|
||||||
---------W-------------------W-------------------W-------------------W-------------------W----------
|
|
||||||
----------o------------------o-------------------o-------------------o------------------o-----------
|
|
||||||
------------r------------------r-----------------r-----------------r------------------r-------------
|
|
||||||
---------------l----------------l----------------l----------------l----------------l----------------
|
|
||||||
-----l-------------d--------------d--------------d--------------d--------------d-------------l------
|
|
||||||
------------o-----------!------------!-----------!-----------!------------!-----------o------------e
|
|
||||||
---------e--------- --------- --------- --------- --------- --------- --------- ---------l---------H
|
|
||||||
-------------------l------W-------H------H-------H-------H------H-------W------l-------e------------
|
|
||||||
----------------------------l----o-----e----e----e----e----e-----o----o----l------------------------
|
|
||||||
------------------------------------o---r--l--l--l--l--l--r--- --l----------------------------------
|
|
||||||
------------------------------------------- l-ll-l-ll-lW-o------------------------------------------
|
|
||||||
-----------------------------------------------Wdooo------------------------------------------------
|
|
||||||
-------------------------------------------------o--------------------------------------------------
|
|
||||||
------------------------------------------------rW -------------------------------------------------
|
|
||||||
---------------------------------------------lHoooooHdr---------------------------------------------
|
|
||||||
----------------------------------------d-e-r--r-r-r--r-e-!-l---------------------------------------
|
|
||||||
---------------------------------!---l---l---l---l---l---l---l--- ----d-----------------------------
|
|
||||||
------------------------ -----l-----d------d-----d-----d------d-----l-----H------!------------------
|
|
||||||
--------------H--------o--------!-------!--------!--------!-------!--------o--------e-------- ------
|
|
||||||
----e---------- ---------- ----------- ---------- ---------- ----------- ---------- ----------l-----
|
|
||||||
--------W-------------H------------H-------------H-------------H------------H-------------W---------
|
|
||||||
-o---------------e---------------e---------------e---------------e---------------e---------------o--
|
|
||||||
--------------l----------------l-----------------l-----------------l----------------l---------------
|
|
||||||
-----------l------------------l------------------l------------------l------------------l------------
|
|
||||||
---------o-------------------o-------------------o-------------------o-------------------o----------
|
|
||||||
--------- ------------------- ------------------- ------------------- ------------------- ----------
|
|
||||||
----------W------------------W-------------------W-------------------W------------------W-----------
|
|
||||||
------------o------------------o-----------------o-----------------o------------------o-------------
|
|
||||||
---------------r----------------r----------------r----------------r----------------r----------------
|
|
||||||
-----r-------------l--------------l--------------l--------------l--------------l-------------r------
|
|
||||||
------------l-----------d------------d-----------d-----------d------------d-----------l------------l
|
|
||||||
</pre>
|
|
||||||
|
|
||||||
Work in progress :)
|
|
||||||
|
|
||||||
# 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 Wheel and Twine (<https://packaging.python.org/key_projects/#twine>):
|
|
||||||
|
|
||||||
`$ pip install wheel 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!
|
|
@ -21,7 +21,7 @@ def text (mark_text):
|
|||||||
return char
|
return char
|
||||||
return f
|
return f
|
||||||
|
|
||||||
def single (char=' '):
|
def single (char='x'):
|
||||||
"""Mark with a single character."""
|
"""Mark with a single character."""
|
||||||
def f():
|
def f():
|
||||||
return char
|
return char
|
||||||
|
6
setup.py
6
setup.py
@ -2,9 +2,9 @@ from setuptools import setup
|
|||||||
|
|
||||||
setup(
|
setup(
|
||||||
name='asciiWriter',
|
name='asciiWriter',
|
||||||
version='0.0.2',
|
version='0.0.3',
|
||||||
author='Gijs de Heij, Manetta Berends',
|
author='Gijs de Heij, Manetta Berends',
|
||||||
author_email='info@varia.zone',
|
author_email='asciiwriter@osp.kitchen, info@varia.zone',
|
||||||
packages=['asciiWriter', 'asciiWriter.examples'],
|
packages=['asciiWriter', 'asciiWriter.examples'],
|
||||||
scripts=[],
|
scripts=[],
|
||||||
package_data={'asciiWriter.examples': [
|
package_data={'asciiWriter.examples': [
|
||||||
@ -17,7 +17,7 @@ setup(
|
|||||||
license='LICENSE.txt',
|
license='LICENSE.txt',
|
||||||
keywords=['plaintext', 'layout software', 'ascii art'],
|
keywords=['plaintext', 'layout software', 'ascii art'],
|
||||||
description='A python library to draw with ASCII (but with Unicode)',
|
description='A python library to draw with ASCII (but with Unicode)',
|
||||||
long_description=open('README.txt').read(),
|
long_description=open('README.md').read(),
|
||||||
long_description_content_type='text/markdown',
|
long_description_content_type='text/markdown',
|
||||||
install_requires=[],
|
install_requires=[],
|
||||||
)
|
)
|
Loading…
Reference in New Issue
Block a user