From b3eba245cce35e1dee10de5fb2253a9d0f1bac20 Mon Sep 17 00:00:00 2001 From: heck Date: Wed, 9 Aug 2023 01:36:02 +0200 Subject: [PATCH] Doc: improve README.md --- README.md | 28 ++++++++++++++++++---------- 1 file changed, 18 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 3300d53..c325c9e 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,13 @@ +# FV-1 Project template +This is a project template with which you can start coding for the fv-1 chip right away, in assembler. +The toolchain.sh script provides a complete open source toolchain. +There is a Makefile based build using this toolchain, but the toolchain functions can also be used anywhere of course. +For mac and linux. -# Build Dependencies +## Build Dependencies -## The assembler - asfv1 +### The assembler - asfv1 build from source: https://github.com/ndf-zz/asfv1 @@ -10,38 +15,41 @@ or `pip install asfv1` -## The flash-tool - ch341eeprom +### The flash-tool - ch341eeprom https://github.com/command-tab/ch341eeprom run `make` it should just work, terribly simple program. -## Hex2bin Converter - srecord (optional) +### Hex2bin Converter - srecord (optional) This is not required when using the asfv1 assembler as it already produces bin files. `port install srecord` -# Build +## Build To build switch into dir `src` to execute the makefile targets -## Makefile Targets +### Makefile Targets `make flash` - Build and upload all the 8 programs `make all` - Only compile all the 8 programs +`make erase` - erases the rom chip `make clean` -`make erase` -The +## Toolchain Setup -# Toolchain Setup +You dont need this for the makefile build, only if you want to use the toolchain directly from the shell. -`source env.sh` to get the commands +`source env.sh` to get the commands () * `fvcompile` * `fvhex2bin` * `fvflash` * `fverase` +## Test + +If everything worked well, you should have a delay effect on program nr 0. \ No newline at end of file