Update readme and repositories

This commit is contained in:
Yannick Reiß 2024-05-17 12:03:16 +02:00
parent bbdf5ece5c
commit 595ae8ce20
1 changed files with 6 additions and 15 deletions

View File

@ -44,11 +44,11 @@ The instructions are direct translations of the 8 brainfuck operands:
Every instruction is calculated in two clock cycles, or one instruction cycle. Every instruction is calculated in two clock cycles, or one instruction cycle.
----------------------------------------------------------------------------------------------- ---
## The compiler ## The compiler
The compiler located in the directory *bfpcompiler* can be used to create the machine code for the different destinations. The compiler located in the directory _bfpcompiler_ can be used to create the machine code for the different destinations.
### Building the compiler ### Building the compiler
@ -59,7 +59,7 @@ cd bfpcompiler
make make
``` ```
The executable will be located in the directory *bfpcompiler*. The executable will be located in the directory _bfpcompiler_.
### Usage ### Usage
@ -85,17 +85,8 @@ The compiler reacts to the following problems:
The last warning occurs, because the logisim implementation of the processor is not capable of processing nested loops. The last warning occurs, because the logisim implementation of the processor is not capable of processing nested loops.
It can be safely ignored on other devices. It can be safely ignored on other devices.
### Code is correct by proof
The proof is located at *bfpcompiler/proof.md* and will be expanded on the whole compiler.
The proofs cover three claims:
- The compiler is working absolutely memory safe
- Every program accepted by the compiler is a valid brainfuck program
- The compiled program is working in the same way, as the entered brainfuck code
## Repository location ## Repository location
The original repository with the most recent code is located at [My personal gitlab](https://gitlab.schnick.duckdns.org/schnick/bfpu). The original repository with the most recent code is located at [My personal git server](https://git.nickr.eu/yannickreiss/brainfuck_processor).
Access can be requested via [e-mail](mailto:schnick@nickr.eu).
As this instance has some problems with staying online, the master-branch is mirrored to Github at [this repository](https://github.com/yannickreiss/brainfuck_processor). Alternatively, the master branch is mirrored to github here [https://github.com/yannickreiss/brainfuck_processor].