From b7fff2db3390eeab3b56a8914ba25f15f1e512df Mon Sep 17 00:00:00 2001 From: Nochalek Date: Tue, 22 Nov 2022 19:01:33 +0100 Subject: [PATCH] Readme and Requirements --- README.md | 26 ++++++++++++++++++++++++++ requirements.txt | 1 + 2 files changed, 27 insertions(+) create mode 100644 README.md create mode 100644 requirements.txt diff --git a/README.md b/README.md new file mode 100644 index 0000000..51af25a --- /dev/null +++ b/README.md @@ -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. +
+ +## 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. +
+ +## 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. +
+ +## 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) diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..3d90aaa --- /dev/null +++ b/requirements.txt @@ -0,0 +1 @@ +colorama \ No newline at end of file