alessandro trinca tornidor
commited on
Commit
·
5b67a75
1
Parent(s):
a90c443
doc: update README.md
Browse files
README.md
CHANGED
|
@@ -4,11 +4,11 @@ A simple helper for writers.
|
|
| 4 |
|
| 5 |
## Overview
|
| 6 |
|
| 7 |
-
[My Ghost Writer](https://github.com/trincadev/my_ghost_writer/) is a web application that analyzes text and provides words frequency statistics. It allows users to upload or type in a text, and then displays the most common words and their
|
| 8 |
|
| 9 |
## Features
|
| 10 |
|
| 11 |
-
*
|
| 12 |
* Use NLP to stem words for more accurate results
|
| 13 |
* Support for uploading or typing in text
|
| 14 |
* User-friendly interface with a simple editor and display of word frequencies
|
|
@@ -22,7 +22,7 @@ A simple helper for writers.
|
|
| 22 |
|
| 23 |
## Getting Started
|
| 24 |
|
| 25 |
-
In a
|
| 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
|
|
@@ -30,7 +30,7 @@ In a linux/WSL environment (I didn't tried with MacOS or Windows):
|
|
| 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 |
|
|
|
|
| 4 |
|
| 5 |
## Overview
|
| 6 |
|
| 7 |
+
[My Ghost Writer](https://github.com/trincadev/my_ghost_writer/) is a web application that analyzes text and provides words frequency statistics. It allows users to upload or type in a text, and then displays the most common words, their frequencies and their position with the text editor. The application uses natural language processing (NLP) techniques to stem words, making it easier to identify patterns and trends in the text.
|
| 8 |
|
| 9 |
## Features
|
| 10 |
|
| 11 |
+
* Analyse large texts and provide words frequency statistics
|
| 12 |
* Use NLP to stem words for more accurate results
|
| 13 |
* Support for uploading or typing in text
|
| 14 |
* User-friendly interface with a simple editor and display of word frequencies
|
|
|
|
| 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
|
|
|
|
| 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 my_ghost_writer/app.py`
|
| 34 |
|
| 35 |
## Contributing
|
| 36 |
|