From bd07de84f97b8c4496bc62782f83bf817267d705 Mon Sep 17 00:00:00 2001
From: Persson-dev <sim16.prib@gmail.com>
Date: Fri, 6 Dec 2024 17:03:07 +0100
Subject: [PATCH] update README

---
 README.md | 68 +++++++++++++++++++++++++++++++++++--------------------
 1 file changed, 44 insertions(+), 24 deletions(-)

diff --git a/README.md b/README.md
index 825b4ad..2062d05 100644
--- a/README.md
+++ b/README.md
@@ -16,26 +16,26 @@ There are 3 format types :
 
 ```assembly
 operations:
-	add R1 R2 #1
-	sub R1 R2 R3
-	and R1 R2 #33
-	xor R1 R2 R3
-	or R1 R2 R3
-	sl R1 R2 R3
-	sr R1 R2 R3
-	mul R1 R2 R3
+	ADD R1 R2 #1
+	SUB R1 R2 R3
+	AND R1 R2 #33
+	XOR R1 R2 R3
+	OR R1 R2 R3
+	SL R1 R2 R3
+	SR R1 R2 R3
+	MUL R1 R2 R3
 io:
-	str R1 R2 R3
-	ld R1 R2 R3
+	STR R1 R2 R3
+	LD R1 R2 R3
 sauts:
-	jmp controle
-	jequ R1 R2 io
-	jneq R1 R2 sauts
-	jsup R1 R2 operations
-	jinf R1 R2 controle
+	JMP controle
+	JEQU R1 R2 io
+	JNEQ R1 R2 sauts
+	JSUP R1 R2 operations
+	JINF R1 R2 controle
 controle:
-	call io
-	ret
+	CALL io
+	RET
 ```
 
 Produces
@@ -49,20 +49,25 @@ Produces
 01010000 10100110 00000000 00000000
 01100000 10100110 00000000 00000000
 01110000 10100110 00000000 00000000
-01000001 01001100 00000000 00000000
-01010001 01001100 00000000 00000000
+01000000 10100110 00000000 00000000
+01010000 10100110 00000000 00000000
 11000000 00000000 00000000 00010000
-11010001 01000000 00000000 00001001
-11100001 01000000 00000000 00001011
-11110001 01000000 00000000 00000001
-11000001 01000000 00000000 00010000
+11010000 10100000 00000000 00001001
+11100000 10100000 00000000 00001011
+11110000 10100000 00000000 00000001
+11000000 10100000 00000000 00010000
 11010000 00000000 00000000 00001001
 11100000 00000000 00000000 00000000
 ```
 
+## Releases
+
+Pre-compiled binaries are available in the [Release](https://git.ale-pri.com/Persson-dev/Assembleur/releases) section.
+
 ## Build
 
-You should have [xmake](https://xmake.io) installed
+If you wish to compile yourself, you must have [xmake](https://xmake.io) installed.
+Instructions on how to install (and you should) [here](https://xmake.io/#/guide/installation)
 
 ```bash
 xmake
@@ -73,3 +78,18 @@ xmake
 ```bash
 xmake run Assembleur [args]
 ```
+
+Example :
+
+```bash
+xmake run Assembleur test.asm -o memory
+```
+
+Parses the file `test.asm` and writes the output into the file `memory`
+
+## Install
+
+You can also add the binary to your path using
+```bash
+xmake install
+```
\ No newline at end of file