alessandro trinca tornidor
commited on
Commit
·
d93f88f
1
Parent(s):
f2a3b75
doc: update README.md and rename wrong changelog filename
Browse files- CHANGELOG.md+ → CHANGELOG.md +4 -0
- README.md +25 -0
CHANGELOG.md+ → CHANGELOG.md
RENAMED
|
@@ -1,5 +1,9 @@
|
|
| 1 |
# Changelog
|
| 2 |
|
|
|
|
|
|
|
|
|
|
|
|
|
| 3 |
## 0.2.1
|
| 4 |
|
| 5 |
- Now it can import My Ghost Writer version
|
|
|
|
| 1 |
# Changelog
|
| 2 |
|
| 3 |
+
## 0.3.0
|
| 4 |
+
|
| 5 |
+
- add an installation script (python required), mostly useful for lite.koboldai.net users
|
| 6 |
+
|
| 7 |
## 0.2.1
|
| 8 |
|
| 9 |
- Now it can import My Ghost Writer version
|
README.md
CHANGED
|
@@ -34,6 +34,8 @@ In a Linux/WSL environment (I didn't tried with MacOS or Windows):
|
|
| 34 |
* `python my_ghost_writer/app.py` using the python app.py file path
|
| 35 |
* `python -m ghost_writer.app.py` using the python module
|
| 36 |
|
|
|
|
|
|
|
| 37 |
If using the webserver with the module (`python -m ghost_writer.app.py`) it's necessary one of these env variables:
|
| 38 |
|
| 39 |
* `STATIC_FOLDER` to define a custom path for the static folder. Probably you should also download the static files:
|
|
@@ -44,6 +46,29 @@ If using the webserver with the module (`python -m ghost_writer.app.py`) it's ne
|
|
| 44 |
* `/health`
|
| 45 |
* `/words-frequency`
|
| 46 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 47 |
## Contributing
|
| 48 |
|
| 49 |
Pull requests are welcome! Please make sure to test your changes thoroughly before submitting a pull request.
|
|
|
|
| 34 |
* `python my_ghost_writer/app.py` using the python app.py file path
|
| 35 |
* `python -m ghost_writer.app.py` using the python module
|
| 36 |
|
| 37 |
+
### Run as a python module
|
| 38 |
+
|
| 39 |
If using the webserver with the module (`python -m ghost_writer.app.py`) it's necessary one of these env variables:
|
| 40 |
|
| 41 |
* `STATIC_FOLDER` to define a custom path for the static folder. Probably you should also download the static files:
|
|
|
|
| 46 |
* `/health`
|
| 47 |
* `/words-frequency`
|
| 48 |
|
| 49 |
+
### Installation script
|
| 50 |
+
|
| 51 |
+
An alternate way to use the project is installing it using `install.sh`. e.g.
|
| 52 |
+
|
| 53 |
+
```bash
|
| 54 |
+
bash ./install.sh
|
| 55 |
+
```
|
| 56 |
+
|
| 57 |
+
If you want to run my custom frontend using this script (available on default on port 7860):
|
| 58 |
+
|
| 59 |
+
1. use the install-only option
|
| 60 |
+
2. define a custom path for `STATIC_FOLDER` and use it for the module execution:
|
| 61 |
+
|
| 62 |
+
```bash
|
| 63 |
+
# run the script with the install-only option
|
| 64 |
+
bash install.sh -i
|
| 65 |
+
|
| 66 |
+
# run the python module with the custom STATIC_FOLDER env variable, e.g.
|
| 67 |
+
# if you already created STATIC_FOLDER within the current directory with the needed files within, see above
|
| 68 |
+
export STATIC_FOLDER=$PWD/static
|
| 69 |
+
python -m my_ghost_writer.app
|
| 70 |
+
```
|
| 71 |
+
|
| 72 |
## Contributing
|
| 73 |
|
| 74 |
Pull requests are welcome! Please make sure to test your changes thoroughly before submitting a pull request.
|