Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
bieli committed Jan 30, 2024
1 parent 7b10493 commit 92818ad
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,31 @@
# Visual learning PDF exercis file generator [![Build Status](https://travis-ci.org/bieli/visual-learning-generator.png)](https://travis-ci.org/bieli/visual-learning-generator)
# Visual learning PDF exercise file generator

![CI Build Status](https://github.com/bieli/visual-learning-generator/actions/workflows/ci.yaml/badge.svg)

Examples PDFs generated by this script are in /examples subdir.
Enjoy :-)

How to run PDF generator?
-----
```
$ python3.7 -m venv venv
$ python3 -m venv venv
$ source venv/bin/activate
(venv) $ pip3 install -r requirements.txt
(venv) $ python3 visuallearning.py
(venv) $ evince visuallearning.pdf # to view output PDF generated file
```

How to run unit test ?
How to run unit tests ?
----
```
$ python3.7 -m venv venv
$ python3 -m venv venv
$ source venv/bin/activate
(venv) $ pip3 install -r requirements-dev.txt
(venv) $ make tests
```


Practical usage example
----


![](visual_learning.practice_example.gif)

0 comments on commit 92818ad

Please sign in to comment.