more settings

ibfi-ts/README.md

@@ -1,46 +1,25 @@
-# Getting Started with Create React App
+# Interactive Brainfuck Interpreter in React TS
 
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+This is an interactive interpreter for the brainfuck programming language.  
+It provides simple brainfuck execution, along with a view of the memory, the memory pointer, the current state of the
+code and more.
 
-## Available Scripts
+It is great for debugging brainfuck programs, including a memory view, program view, the location of the pointers, the
+ability to directly edit memory.  
+You can step manually through the program, or set the execution speed to whatever speed fits best.   
+This interpreter also has the ability to set breakpoints using the • symbol. This means you can let your code run fast and
+stopping it at any point in your program to see what went wrong.
 
-In the project directory, you can run:
+## Features
+* brainfuck execution including IO
+* memory view
+* code state view
+* manual stepping
+* breakpoints
+* error messages
 
-### `yarn start`
 
-Runs the app in the development mode.\
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
-
-The page will reload if you make edits.\
-You will also see any lint errors in the console.
-
-### `yarn test`
-
-Launches the test runner in the interactive watch mode.\
-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
-
-### `yarn build`
-
-Builds the app for production to the `build` folder.\
-It correctly bundles React in production mode and optimizes the build for the best performance.
-
-The build is minified and the filenames include the hashes.\
-Your app is ready to be deployed!
-
-See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
-
-### `yarn eject`
-
-**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
-
-If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
-
-Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
-
-You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
-
-## Learn More
-
-You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
-
-To learn React, check out the [React documentation](https://reactjs.org/).
+### Future features
+* seeing ASCII characters in memory
+* fast excecution mode (no debugging info)
+* better speed control