alessandro trinca tornidor
commited on
Commit
·
991299a
1
Parent(s):
6ba5906
doc: update README.md for a better description of the project setup procedure
Browse files
README.md
CHANGED
|
@@ -22,9 +22,15 @@ A simple helper for writers.
|
|
| 22 |
|
| 23 |
## Getting Started
|
| 24 |
|
| 25 |
-
|
| 26 |
-
|
| 27 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 28 |
|
| 29 |
## Contributing
|
| 30 |
|
|
|
|
| 22 |
|
| 23 |
## Getting Started
|
| 24 |
|
| 25 |
+
In a linux/WSL environment (I didn't tried with MacOS or Windows):
|
| 26 |
+
|
| 27 |
+
1. Clone the repository using `git clone https://github.com/trincadev/my_ghost_writer`, `cd my_ghost_writer`
|
| 28 |
+
2. Create a [virtualenv](https://virtualenv.pypa.io/en/latest/user_guide.html) and install the project dependencies using an existing python version with
|
| 29 |
+
|
| 30 |
+
* [poetry](https://python-poetry.org/) (`poetry env use 3.12.10`, `poetry install`, `eval $(poetry env activate)`)
|
| 31 |
+
* `python -m venv .venv`, `source .venv/bin/activate`, `pip install -r requirements.txt` (and the other requirements files if you need also the webserver and/or the test environment)
|
| 32 |
+
|
| 33 |
+
3. Run the application using `python app.py`
|
| 34 |
|
| 35 |
## Contributing
|
| 36 |
|