Xameren/Txt-File-Analyser
1
0
Fork 0
mirror of https://github.com/Xameren/Txt-File-Analyser.git synced 2025-02-04 08:39:23 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Xameren 2024-10-12 00:47:41 +02:00 • committed by GitHub
parent 15b09c6197
commit 6887cfd566
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 21 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
README.md
View file

@ -1,2 +1,21 @@
# Txt-File-Analyser
A simple text analyser
## Xameren text file 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)