瀏覽代碼

Changing the readme

develop-theo
Theo Souchon 2 年之前
父節點
當前提交
38b6693d23
共有 1 個檔案被更改,包括 12 行新增6 行删除
  1. +12
    -6
      README.md

+ 12
- 6
README.md 查看文件

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

Loading…
取消
儲存