summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBernát Gábor <bgabor8@bloomberg.net>2020-07-24 20:15:52 +0100
committerGitHub <noreply@github.com>2020-07-24 20:15:52 +0100
commitc91a77a8a27dc3d0cca34b05021b9f35cd42e2d4 (patch)
tree98779ee87d722a8d95883a9265ba6f0d0ed6bdd7 /README.md
parent38cb66b9c58db8eb5c567305086dca9b7b384fd6 (diff)
downloadtox-git-c91a77a8a27dc3d0cca34b05021b9f35cd42e2d4.tar.gz
Fix CI (#1556)
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 15 insertions, 15 deletions
diff --git a/README.md b/README.md
index de4c4b12..5d3402d2 100644
--- a/README.md
+++ b/README.md
@@ -36,7 +36,7 @@ tox is mainly used as a command line tool and needs a `tox.ini` or a
To test a simple project that has some tests, here is an example with
a `tox.ini` in the root of the project:
-``` {.sourceCode .ini}
+```{.sourceCode .ini}
[tox]
envlist = py27,py37
@@ -45,7 +45,7 @@ deps = pytest
commands = pytest
```
-``` {.sourceCode .console}
+```{.sourceCode .console}
$ tox
[lots of output from what tox does]
@@ -57,9 +57,9 @@ __________________ summary _________________
congratulations :)
```
-tox created two ``testenvs`` - one based on Python2.7 and one based on
+tox created two `testenvs` - one based on Python2.7 and one based on
Python3.7, it installed pytest in them and ran the tests. The report at
-the end summarizes which ``testenvs`` have failed and which have
+the end summarizes which `testenvs` have failed and which have
succeeded.
**Note:** To learn more about what you can do with tox, have a look at
@@ -71,7 +71,7 @@ tox](https://github.com/search?l=INI&q=tox.ini+in%3Apath&type=Code).
### How it works
tox creates virtual environments for all configured so called
-``testenvs``, it then installs the project and other necessary
+`testenvs`, it then installs the project and other necessary
dependencies and runs the configured set of commands. See [system
overview](https://tox.readthedocs.io/en/latest/#system-overview) for
more details.
@@ -85,16 +85,16 @@ more details.
### tox can be used for ...
-- creating development environments
-- running static code analysis and test tools
-- automating package builds
-- running tests against the package build by tox
-- checking that packages install correctly with different Python
- versions/interpreters
-- unifying Continuous Integration and command line based testing
-- building and deploying project documentation
-- releasing a package to PyPI or any other platform
-- limit: your imagination
+- creating development environments
+- running static code analysis and test tools
+- automating package builds
+- running tests against the package build by tox
+- checking that packages install correctly with different Python
+ versions/interpreters
+- unifying Continuous Integration and command line based testing
+- building and deploying project documentation
+- releasing a package to PyPI or any other platform
+- limit: your imagination
### Documentation