chore: add readme to the repo

This commit is contained in:
2021-06-16 20:27:16 -04:00
parent 22761f5be7
commit 435751b4dd
6 changed files with 47 additions and 4 deletions

44
README.md Normal file
View File

@@ -0,0 +1,44 @@
# dopey - Another Brainf**k Interpreter
The dopey brainf\*\*k interpreter was created as a side project to become familiar with Python 3. The goal was to fully implement all the features of brainf\*\*k as defined in this [wiki page](https://en.wikipedia.org/wiki/Brainfuck#Language_design) into dopey.
## Demo
![gif](https://i.imgur.com/mqjNGzV.gif)
## Implemetation Limitations
The dopey is limited to a memory buffer of **30,000** byte cells all initialized to zero. Any attempts to move the pointer past the bounds of the memory buffer will result in an exception being raised. Attempting to print any cell with a value outside of the defined ASCII characters may also result in an exception.
## Requirements
Make sure you've installed Python 3. You can download and install Python 3 at [python.org](https://www.python.org/downloads/).
Verify you have Python 3 installed by running the following:
```bash
python --version
```
or in some systems
```bash
python3 --version
```
## Running dopey
Clone the Github repository. From your terminal move to the root of the project and run the following line:
```bash
python dopey.py my-bf-file.bf
```
or in some systems
```bash
python3 dopey.py my-bf-file.bf
```
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
## License
[MIT](https://choosealicense.com/licenses/mit/)