Skip to content

Commit

Permalink
Update documentation (#342)
Browse files Browse the repository at this point in the history
  • Loading branch information
rokasramas committed Sep 22, 2021
1 parent 511223b commit c3a7506
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 1 deletion.
6 changes: 5 additions & 1 deletion docs/export.md
Expand Up @@ -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 \
Expand Down
12 changes: 12 additions & 0 deletions 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/).
1 change: 1 addition & 0 deletions mkdocs.yml
Expand Up @@ -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
Expand Down

0 comments on commit c3a7506

Please sign in to comment.