Readme and Requirements

This commit is contained in:
Nochalek 2022-11-22 19:01:33 +01:00
parent d658fd0c95
commit b7fff2db33
2 changed files with 27 additions and 0 deletions

26
README.md Normal file
View File

@ -0,0 +1,26 @@
# eCLI
### eCLI is a command line interface made for fun and learning purposes. It is written in Python and is very simple to use.
<br>
## Usage
### To use eCLI you need to have Python 3 installed on your device, then you can install the requirements by running `pip install -r requirements.txt` in the eCLI directory. After that you can run `python eCLI.py` to start the program.
<br>
## Commands
### The following commands are available in eCLI:
- `pcinfo` - Shows information about your device
- `info` - Shows information about eCLI
- `help` - Shows a list of all commands
- `clear` - Clears the screen
- `exit` - Exits the program
### You can also access this list by running `help` in eCLI.
<br>
## To Do
### The following things are planned to be added to eCLI:
- Add more commands
- Add downloadable modules/plugins
- Add a module/plugin manager
- Make something unique so that eCLI is not just another CLI
- Automatic updates
- Better colors and formatting (Preferably without the need for colorama)

1
requirements.txt Normal file
View File

@ -0,0 +1 @@
colorama