Browse Source

Changing the readme

develop-theo
Theo Souchon 2 years ago
parent
commit
38b6693d23
1 changed files with 12 additions and 6 deletions
  1. +12
    -6
      README.md

+ 12
- 6
README.md View File

@ -2,7 +2,7 @@
C compiler with embedded metalanguage.
## Table of contents
## <div id="toc">Table of contents<div>
1. [Architecture](#ar)
2. [Build the project](#bp)
- [Requirements](#ar)
@ -16,7 +16,9 @@ C compiler with embedded metalanguage.
## <div id="ar">Architecture<div>
![alt text](/media/ccmeta.drawio.png)
![alt text](http://git.piumarta.com/piumarta/ccmeta/raw/branch/develop/media/ccmeta.drawio.png)
### [Go to the table of contents](#toc)
## <div id="bp">Build the project<div>
### <div id="req">Requirements<div>
@ -31,9 +33,9 @@ $ brew install bdw-gc
```
### <div id="makefile"> Makefile<div>
>Compatible with the homebrew installed on the apple silicon ship
#### <div id="makefile_Build">Build<div>
```bash
$ make
```
@ -47,11 +49,12 @@ $ make clean
```bash
$ make test
```
### [Go to the table of contents](#toc)
## <div id="usage">Usage<div>
### How it works
You can pass your program:
* via a file
* via an input file
```bash
$ ./ccmeta < file
```
@ -59,6 +62,8 @@ $ ./ccmeta < file
```bash
$ ./ccmeta file
```
### **Check each test file to get an idea of how parsimony works**
### [Go to the table of contents](#toc)
## <div id="help">Help<div>
@ -66,4 +71,5 @@ $ ./ccmeta file
``` shell
$ man peg
```
```
### [Go to the table of contents](#toc)

Loading…
Cancel
Save