Skip to content

Commit

Permalink
Hotfix Updated README.md (#31)
Browse files Browse the repository at this point in the history
* Included information on how to uninstall the Monty interpreter.
* Also updated the documentation on how to install it. Included
information on why it is important to change into the directory cloned.
  • Loading branch information
Ebuube authored Jul 1, 2023
1 parent a05c6f2 commit d3471f1
Showing 1 changed file with 16 additions and 6 deletions.
22 changes: 16 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,24 @@ Monty 0.98 is a scripting language that is first compiled into Monty byte codes

1. First, clone this repository:
```
vagrant@ubuntu:~$ git clone https://github.com/Ebuube/monty.git
vagrant@ubuntu:~$ git clone https://github.com/Ebuube/Monty_language.git
```

2. Then run the `Makefile`
2. Change into this newly created directory:<br>
```
vagrant@ubuntu:~$ cd Monty_language
vagrant@ubuntu:~/Monty_language$
```

3. Then run the `Makefile`
> #Note: Ensure you have `gcc` and `make` installed on your system before running the Makefile.
```
vagrant@ubuntu:~$ make
vagrant@ubuntu:~/Monty_language$ make
```

If you don't have `make` utility installed, check out how to install it. For Ubuntu, you can look at this documentation [How to install make on Ubuntu](https://linuxhint.com/install-make-ubuntu/)

3. Confirm installation by running the monty command on a sample bytecode file and expect the result shown below. Example:
4. Confirm installation by running the monty command on a sample bytecode file and expect the result shown below. Example:
```
vagrant@ubuntu:~$ cat bytecode.m
push 1
Expand All @@ -42,9 +48,13 @@ Monty 0.98 is a scripting language that is first compiled into Monty byte codes
> #Note: Once installed, you can use monty anywhere in your machine :).
### To Uninstall
Run the `clean` target of **make** thus:<br>
Change into the repository you cloned and run the `clean` target of **make** thus:<br>
```
vagrant@ubuntu:~/Monty_language$ make clean
```
If the repo has been deleted or is no where to be found, you can easily unisintall 'monty' by removing the binary file from the **/usr/bin** directory thus:<br>
```
vagrant@ubuntu:~$ make clean
vagrant@ubuntu:~$ sudo rm /usr/bin/monty
```

</details>
Expand Down

0 comments on commit d3471f1

Please sign in to comment.