Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
namanjain-iitr authored May 13, 2021
1 parent e67ad25 commit 7c497fd
Showing 1 changed file with 32 additions and 3 deletions.
35 changes: 32 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
**To execute the shell:**

```shell
./output/main
```

**To Modify and rebuild shell:**

```shell
sudo apt-get update
sudo apt-get install cmake
cmake .
make
./output/main
Expand All @@ -25,18 +33,39 @@ c++17 required

<h3>Implemented</h3>
<ol>
<li>All Linux Commands are supported (tell if some commands doesn't work)</li>
<li>All Linux Commands are supported.</li>
<li>Batch Mode done (Use "rsh filename.rsh" \\ Only .rsh files allowed)</li>
<li>Git Branch, Username, PC name and current directory display during input prompt.</li>
<li>"exit" can be used to exit the shell and revert to default linux shell</li>
<li>pipes ('|') and redirections ('<' or '>' or '>>') supported</li>
<li>Google a word for its meaning in more than 6 languages</li>
<li>"history" command can be used to list all the commands used in current shell session.</li>
</ol>

<h3>Remaining</h3>
<ol>
<li>Aliases not yet implemented.</li>
<li>cd is not fully functional.</li>
<li>Commands contatining string (" ") may not function properly.</li>
</ol>

<h3>Additional Features</h3>

<h3>Implemented</h3>
<ol>
<li>Basic Text editing while entering command is supported.</li>
<li>Command History access using &#8593 and &#8595 arrow key.(Limited to current shell session only)</li>
<li>Tab Auto-Completion during input is supported.</li>
<li>Basic Arithmetic Operation can be performed using "calc [expresssion]".<br /> (Here expression is any mathematical expression without a space) </li>
<li>"google <word_to_search> <optional:lang_code>" can be used to google meaning of any word.<br />
(Note: An active Internet Connection is required to run this command.)</li>
</ol>
<h3>Beginner Shell Tutorial</h3>

<h3>Implemented</h3>
<ol>
<li>"tutorial" command be used to run tutorial content and learn about basic shell and git commands inside shell.</li>
<li>"tutorial level <level-number>" can be used to access practice levels and find the hidden flag using shell commands.</li>
<li>"tutorial level <level-number> password" can be used to submit the hidden flag in grading software and pass that level.</li>
</ol>

**Errors and Solutions:**
Expand Down

0 comments on commit 7c497fd

Please sign in to comment.