Skip to content

Commit

Permalink
Add save-rvasm documentation in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
eric15342335 committed Aug 29, 2024
1 parent 807e74d commit b062974
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 1 deletion.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,17 @@ Older hardware (InspireMatrix):
* `save-rvasm`
* Add saving and loading features
* Uses `rv-asm`.
* How to play:
* Before the load save menu appear, hold `X` to clear all the saved paints.
* Pick a saved program to load. Each program size is 32 instructions (hence 64 bytes / 1 page in the filesystem).
* Press `Y` to load the default program (Smile face) instead of loading a saved program.
You must choose this if no program are saved.
* Use `UP` and `DOWN` to navigate the instruction pages. The top 32 LEDs in light pink indicates
which page is currently displayed. E.g. 1 LED on => page 1 => Instruction 1 and 2.
* Use `Y` to execute the program.
* The button `32` LEDs are used to display the current instruction, with the active bit highlighted as `blue`.
* Notes when writing programs:
* You `MUST` end your program with an `ecall` (a.k.a `0x0073`) to exit the program.

* `snake-game`
* Porting the classic snake game to `InspireMatrix`, which has `8x8`=`64` LEDs and `up / down / left / right` controls.
Expand Down Expand Up @@ -194,6 +205,8 @@ Great thanks to these projects (LICENSE included):
* <https://github.com/cnlohr/ch32v003fun>
* <https://github.com/brian-smith-github/ch32v003_stt>
* <https://github.com/mnurzia/rv>
* <https://github.com/michaeljclark/riscv-disassembler>
* <https://github.com/hexeguitar/ch32v003fun_libs>

## Check out our other projects as well

Expand Down
21 changes: 21 additions & 0 deletions ch32v003fun/ch32v003fun_libs_LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2023 Piotr Zapart

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
2 changes: 1 addition & 1 deletion rv-dis/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# RISC-V Disassembler

RISC-V Disassembler with support for RV32/RV64/RV128 IMAFDC
<https://github.com/michaeljclark/riscv-disassembler>

0 comments on commit b062974

Please sign in to comment.