diff --git a/README.md b/README.md index 11531ee9c47ca00a65bcf346ba0b4ffbb5b3888c..6abb0ec4d2f0b927ef14f8077cbe58dbfe4652bc 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ -# Nosh - A Simple Custom Shell for Windows +# Noémi Shell X (NoshX) - A Simple Custom Shell for UNIX-like systems -Nosh is a simple, customizable command-line shell designed for Windows systems. Inspired by Unix-like shells, Nosh provides a variety of basic commands and functionalities, with a few fun additions. It is meant to emulate many of the standard shell operations, as well as offer a unique user experience. This project is open-source, and you are welcome to contribute. +NoshX is a simple, customizable command-line shell designed for UNIX-like systems. Inspired by other UNIX-like shells, Nosh provides a variety of basic commands and functionalities, with a few fun additions. It is meant to emulate many of the standard shell operations, as well as offer a unique user experience. This project is open-source, and you are welcome to contribute.(Read about licensing below) -## Features: +## Features (implemented): `about`: Display information about the shell and its author(s). @@ -11,34 +11,37 @@ Nosh is a simple, customizable command-line shell designed for Windows systems. `clear` or `cls`: Display the version of the shell. -`exec`: Execute executable files. - `exit`: Exit the shell program. -`grasp`: Search through directories for files or directories. Supports: - -`grasp -d <directory>`: List all files and directories in the specified directory. - -`grasp -f <directory>`: (In development) Specify a file to search for, to be implemented with the pattern matching feature. - `help` or `?`: Lists all available commands for Noémi Shell. -`list`: Display the contents of a directory or the current working directory. - -`mkdir`: Create a new directory. Usage: `mkdir <directory_name>`. - `noemi`: Draw a heart shape made of # characters. `noemi -l`: Draw a heart shape made of # characters with more delay. `now`: Gets and prints out the current date and tame. -`rn (rename)`: Rename a file or directory. Usage: `rn <old_name> <new_name>`. - `store`: Save a string of maximum 100 characters during runtime. `store -g`: Show the string saved with `store`. + +## Features to be implemented + +`exec`: Execute executable files. + +`grasp`: Search through directories for files or directories. Supports: + +`grasp -d <directory>`: List all files and directories in the specified directory. + +`grasp -f <directory>`: (In development) Specify a file to search for, to be implemented with the pattern matching feature. + +`list`: Display the contents of a directory or the current working directory. + +`mkdir`: Create a new directory. Usage: `mkdir <directory_name>`. + +`rn (rename)`: Rename a file or directory. Usage: `rn <old_name> <new_name>`. + ## Installation 1. **Clone the repositiory** @@ -53,11 +56,11 @@ g++ -o nosh.exe nosh.cpp ``` Assuming you have `g++` installed. -This will create an executable called `nosh.exe`. +This will create an executable called `nosh`. **Run the Shell** -Once the build completes successfully, run `nosh.exe`. +Once the build completes successfully, run `nosh`. ## Contributing