diff --git a/README.md b/README.md index a2b168ddd5fc6d3db3dd32c9c1dfe94d28b02951..1965b43b68601eb23632bf284a6f11a7f39cc429 100644 --- a/README.md +++ b/README.md @@ -3,16 +3,33 @@ 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. -# Features +## Features: + +`about`: Display information about the shell and its author(s). + +`about --version`: Display the version of the shell. + +`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. + +`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 +| +`rn (rename)`: Rename a file or directory. Usage: `rn <old_name> <new_name>` + +`store`: Save content to a specified file. This could be used to store commands or data for later use. -- **Basic Shell Commands**: `pwd`, `cd`, `clear`, and more -- **Creative and Fun Commands**: `noemi` (draws a heart using `#` characters) -- **File System Operations**: `tap` (create files), `crush` (delete files and directories) -- **File Viewing**: `read` (reads and displays the contents of text files line-by-line) -- **Directory Navigation**: Supports changing to the home directory with `cd` and moving up one directory with `cd ..` -- **Store**: Stores text of maximum 100 characters during runtime -A separate PDF file called **Documentation** will soon be added too. ## Installation