Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated README.md with necessary pre requisites #11

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 50 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,56 @@ To run the shell locally:
./apksh
```

## Prerequisites

To compile and run APKSH, you need:

- GCC compiler
- readline library

On Ubuntu or Debian-based systems, you can install these with:

```
sudo apt-get install gcc libreadline-dev
```

## Compilation

To compile the shell, run:

```
gcc -o shell shell.c -lreadline
```

This will create an executable named `shell`.

## Running the Shell

To start the shell, run:

```
./shell
```

## Usage

Once in the shell, you can use the following built-in commands:

- `cd [directory]`: Change the current directory
- `pwd`: Print the current working directory
- `ls [directory]`: List contents of a directory
- `echo [text]`: Print text to the console
- `help`: Display help message with available commands
- `exit` or `bye`: Exit the shell

You can also run any other commands available in your system PATH.

Use the up and down arrow keys to navigate through command history, and use tab for auto-completion of commands and file paths.

## History

Command history is saved in `~/.apksh_history` and persists between sessions.

# Note
If you are using a windows pc, you will have to first install WSL on your system and download an Ubuntu distro (or any other distro). Clone the repo in the WSL and run it in the linux environment

Expand Down