diff options
| author | JensDiemer <git@jensdiemer.de> | 2020-02-01 15:36:24 +0100 |
|---|---|---|
| committer | JensDiemer <git@jensdiemer.de> | 2020-02-01 15:36:24 +0100 |
| commit | bb11c18ea589ea82019e1315909f5c24f974cd5d (patch) | |
| tree | aeb4648765795d2e3a06a76d8ef65c14b7ae5ac9 | |
| parent | 564c0ba80296927e6891995e8c5baa1d32ab6b56 (diff) | |
| download | creole-bb11c18ea589ea82019e1315909f5c24f974cd5d.tar.gz | |
update README
| -rw-r--r-- | README.creole | 33 | ||||
| -rw-r--r-- | README.rst | 39 |
2 files changed, 57 insertions, 15 deletions
diff --git a/README.creole b/README.creole index ea48cdb..e5a19d2 100644 --- a/README.creole +++ b/README.creole @@ -180,23 +180,42 @@ Creole Markup Cheat Sheet can be found here: http://www.wikicreole.org/wiki/Chea ~$ cd python-creole # install or update poetry: -~/python-crole$ make install-poetry +~/python-creole$ make install-poetry # install python-creole via poetry: -~/python-crole$ make install +~/python-creole$ make install # Run pytest: -~/python-crole$ make pytest +~/python-creole$ make pytest # Run pytest via tox with all environments: -~/python-crole$ make tox +~/python-creole$ make tox # Run pytest via tox with one Python version: -~/python-crole$ make tox-py38 -~/python-crole$ make tox-py37 -~/python-crole$ make tox-py36 +~/python-creole$ make tox-py38 +~/python-creole$ make tox-py37 +~/python-creole$ make tox-py36 }}} +== make targets == + +To see all make targets, just call {{{make}}}: +{{{ +~/python-creole$ make +help List all commands +install-poetry install or update poetry +install install python-creole via poetry +lint Run code formatters and linter +fix-code-style Fix code formatting +tox-listenvs List all tox test environments +tox Run pytest via tox with all environments +tox-py36 Run pytest via tox with *python v3.6* +tox-py37 Run pytest via tox with *python v3.7* +tox-py38 Run pytest via tox with *python v3.8* +pytest Run pytest +update-rst-readme update README.rst from README.creole +publish Release new version to PyPi +}}} == Use creole in README == @@ -246,21 +246,44 @@ unittests ~$ cd python-creole # install or update poetry: - ~/python-crole$ make install-poetry + ~/python-creole$ make install-poetry # install python-creole via poetry: - ~/python-crole$ make install + ~/python-creole$ make install # Run pytest: - ~/python-crole$ make pytest + ~/python-creole$ make pytest # Run pytest via tox with all environments: - ~/python-crole$ make tox + ~/python-creole$ make tox # Run pytest via tox with one Python version: - ~/python-crole$ make tox-py38 - ~/python-crole$ make tox-py37 - ~/python-crole$ make tox-py36 + ~/python-creole$ make tox-py38 + ~/python-creole$ make tox-py37 + ~/python-creole$ make tox-py36 + +------------ +make targets +------------ + +To see all make targets, just call ``make``: + +:: + + ~/python-creole$ make + help List all commands + install-poetry install or update poetry + install install python-creole via poetry + lint Run code formatters and linter + fix-code-style Fix code formatting + tox-listenvs List all tox test environments + tox Run pytest via tox with all environments + tox-py36 Run pytest via tox with *python v3.6* + tox-py37 Run pytest via tox with *python v3.7* + tox-py38 Run pytest via tox with *python v3.8* + pytest Run pytest + update-rst-readme update README.rst from README.creole + publish Release new version to PyPi -------------------- Use creole in README @@ -620,4 +643,4 @@ donation ------------ -``Note: this file is generated from README.creole 2020-02-01 14:17:25 with "python-creole"``
\ No newline at end of file +``Note: this file is generated from README.creole 2020-02-01 15:25:27 with "python-creole"``
\ No newline at end of file |