diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 24 |
1 files changed, 24 insertions, 0 deletions
@@ -28,6 +28,16 @@ AsciiDoc.py is written in Python so you need a Python interpreter package manager for your OS or by downloading it from the official Python website http://www.python.org. +Additionally, you wil need: + +* DocBook XSL Stylesheets 1.76.1 +* xsltproc (libxml 20706, libxslt 10126 and libexslt 815). +* w3m 0.5.2 +* dblatex 0.3 +* FOP 0.95 + +to enable the full AsciiDoc.py toolchain. + ## Obtaining AsciiDoc.py Documentation and installation instructions are on the AsciiDoc.py website @@ -37,6 +47,20 @@ https://asciidoc.org/. Simply, you should use use pip to install it: pip3 install asciidoc ``` +## Contributing + +To contribute and test your changes, you will need to install: +* flake8 +* pytest +* pytest-mock + +To lint the codebase: `python3 -m flake8` + +AsciiDoc.py has the following types of tests: +1. doctests: `python3 -m asciidoc.asciidoc --doctest` +1. unit tests: `python3 -m pytest` +1. integration tests: `python3 tests/testasciidoc.py` + ## LICENSE Copyright (C) 2002-2013 Stuart Rackham. |