mirror of
https://github.com/Xameren/Txt-File-Analyser.git
synced 2025-02-04 08:39:23 +01:00
Update README.md
This commit is contained in:
parent
15b09c6197
commit
6887cfd566
1 changed files with 21 additions and 2 deletions
23
README.md
23
README.md
|
@ -1,2 +1,21 @@
|
||||||
# Txt-File-Analyser
|
## Xameren text file analyser
|
||||||
A simple text analyser
|
A simple text analyser made in python as a CLI application.
|
||||||
|
![An image of the analyser's CLI](https://github.com/Xameren/Txt-File-Analyser/blob/main/Screenshot%20of%20the%20analyser.png)
|
||||||
|
## Installation and Requirements
|
||||||
|
To use this tool, you will need to have Python installed on your machine.
|
||||||
|
|
||||||
|
### Prerequisites
|
||||||
|
- [Python](https://www.python.org/downloads/)
|
||||||
|
|
||||||
|
### Installation
|
||||||
|
Clone the repository:
|
||||||
|
`git clone https://github.com/Xameren/Txt-File-Analyser.git`
|
||||||
|
|
||||||
|
Navigate to the project directory:
|
||||||
|
`cd Txt-File-Analyser`
|
||||||
|
|
||||||
|
Run the Python file:
|
||||||
|
`python Text analyzer.py`
|
||||||
|
|
||||||
|
## Licence
|
||||||
|
The analyzer is currently under the [MIT Licence](LICENSE)
|
||||||
|
|
Loading…
Add table
Reference in a new issue