From 20cb398b72e3d958c11338b0e069a173d947317f Mon Sep 17 00:00:00 2001
From: heck <heck@pep.foundation>
Date: Wed, 9 Aug 2023 01:03:21 +0200
Subject: [PATCH] Doc: Add README.md

---
 README.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 47 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3300d53
--- /dev/null
+++ b/README.md
@@ -0,0 +1,47 @@
+
+
+# Build Dependencies
+
+## The assembler - asfv1
+
+build from source: https://github.com/ndf-zz/asfv1
+
+or
+
+`pip install asfv1` 
+
+## The flash-tool - ch341eeprom
+
+https://github.com/command-tab/ch341eeprom
+
+run `make` it should just work, terribly simple program.
+
+## Hex2bin Converter - srecord (optional)
+This is not required when using the asfv1 assembler as it already produces bin files.
+
+`port install srecord`
+
+
+# Build
+
+To build switch into dir `src` to execute the makefile targets   
+
+## Makefile Targets
+
+`make flash` - Build and upload all the 8 programs   
+`make all` - Only compile all the 8 programs   
+`make clean`   
+`make erase`   
+
+The 
+
+
+# Toolchain Setup
+
+`source env.sh` to get the commands
+
+* `fvcompile`
+* `fvhex2bin`
+* `fvflash`
+* `fverase`
+