diff --git a/docs/export.md b/docs/export.md index b04bcd8ba..17d7a1c66 100644 --- a/docs/export.md +++ b/docs/export.md @@ -2,7 +2,11 @@ When document plan is ready, we can export generated text using one of utility functions that are included in Accelerated Text project. -Go to `utils` folder located in project root, and run this command in the terminal: +To use these utils, [Clojure programming language](https://www.clojure.org/guides/getting_started) must be installed on the system. + +Alternatively, you can use our [Python wrapper for Accelerated Text](py-wrapper.md), which is especially recommended on Windows, since installing Clojure on this operating system may be tricky. + +After Clojure is installed, go to `utils` folder located in project root, and run this command in the terminal: ``` clojure -A:generate \ diff --git a/docs/py-wrapper.md b/docs/py-wrapper.md new file mode 100644 index 000000000..cbd24ad51 --- /dev/null +++ b/docs/py-wrapper.md @@ -0,0 +1,12 @@ +# Python wrapper + +You can interact with Accelerated Text using our [Python wrapper](https://github.com/tokenmill/accelerated-text-py/). + +Main functions of the wrapper include: + +* Interaction with dictionary, document-plans and data-files +* Altering languages and readers +* Text generation +* Working with state + +We encourage using the wrapper inside [Jupyter notebooks](https://jupyter.org/). diff --git a/mkdocs.yml b/mkdocs.yml index 1d07f423c..2c1f63252 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -17,6 +17,7 @@ nav: - Selecting languages: languages.md - Exporting: export.md - Advanced Topics: + - Python wrapper: py-wrapper.md - Blocks: blocks.md - Reader Model: reader-models.md - Data Enrichment: data-enrichment.md