From 38b6693d23511b3dc3ffad5ae43a05a0560fdd94 Mon Sep 17 00:00:00 2001 From: Theo Souchon Date: Mon, 13 Feb 2023 12:58:42 +0900 Subject: [PATCH] Changing the readme --- README.md | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index e5fcb64..e7ac8d5 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ C compiler with embedded metalanguage. -## Table of contents +##
Table of contents
1. [Architecture](#ar) 2. [Build the project](#bp) - [Requirements](#ar) @@ -16,7 +16,9 @@ C compiler with embedded metalanguage. ##
Architecture
-![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) + ##
Build the project
###
Requirements
@@ -31,9 +33,9 @@ $ brew install bdw-gc ``` ###
Makefile
+>Compatible with the homebrew installed on the apple silicon ship ####
Build
- ```bash $ make ``` @@ -47,11 +49,12 @@ $ make clean ```bash $ make test ``` - +### [Go to the table of contents](#toc) ##
Usage
+### 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) ##
Help
@@ -66,4 +71,5 @@ $ ./ccmeta file ``` shell $ man peg -``` \ No newline at end of file +``` +### [Go to the table of contents](#toc) \ No newline at end of file