diff options
| author |  Tom van der Lee <tom@vanderlee.io> | 2021-12-30 09:51:00 +0100 |
|---|---|---|
| committer | Tom van der Lee <tom@vanderlee.io> | 2022-01-11 00:00:22 +0100 |
| commit | bcb77d979d817e1e609adb4d007bbbcc3f61efbd (patch) | |
| tree | 093c5a2914ee0f6e1ec559b3b98725190fee7285 /README.rst | |
| download | client-bcb77d979d817e1e609adb4d007bbbcc3f61efbd.tar.gz client-bcb77d979d817e1e609adb4d007bbbcc3f61efbd.tar.bz2 client-bcb77d979d817e1e609adb4d007bbbcc3f61efbd.zip | |
Prepare for githubv1.0.0
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..16538d9 --- /dev/null +++ b/README.rst | |||
| @@ -0,0 +1,30 @@ | |||
| 1 | =========== | ||
| 2 | TTUN Client | ||
| 3 | =========== | ||
| 4 | |||
| 5 | |Deploy| | ||
| 6 | |||
| 7 | .. |Deploy| image:: https://github.com/tomvanderlee/ttun-client/actions/workflows/python-publish.yml/badge.svg | ||
| 8 | :target: https://github.com/tomvanderlee/ttun-client/actions/workflows/python-publish.yml | ||
| 9 | |||
| 10 | Expose a localport via you selfhosted `TTUN Server <https://github.com/tomvanderlee/ttun-server>`_ | ||
| 11 | |||
| 12 | Installing | ||
| 13 | ---------- | ||
| 14 | |||
| 15 | :: | ||
| 16 | |||
| 17 | pip install ttun | ||
| 18 | |||
| 19 | Developing | ||
| 20 | ---------- | ||
| 21 | |||
| 22 | 1. Create and activate a python 3.10 virtual environment | ||
| 23 | |||
| 24 | 2. Install requirements:: | ||
| 25 | |||
| 26 | pip install -r requirements.txt | ||
| 27 | |||
| 28 | 3. Run:: | ||
| 29 | |||
| 30 | python -m ttun | ||