summaryrefslogtreecommitdiff
path: root/README.creole
diff options
context:
space:
mode:
authorJens Diemer <github.com@jensdiemer.de>2020-02-01 16:38:48 +0100
committerGitHub <noreply@github.com>2020-02-01 16:38:48 +0100
commit1d2fb1c6ac76674939e6f0c34c8623bb6d22e841 (patch)
tree1bfe84ba3ccb2c6100943e282269a82e36016990 /README.creole
parent69037331053950a1a03324ef3486769cc88ed591 (diff)
parent42af9043fc37dcc81767c2466139b3360d17bc7a (diff)
downloadcreole-1d2fb1c6ac76674939e6f0c34c8623bb6d22e841.tar.gz
Merge pull request #42 from jedie/setup-utils
Setup utils
Diffstat (limited to 'README.creole')
-rw-r--r--README.creole33
1 files changed, 26 insertions, 7 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 ==