license update and README

This commit is contained in:
2025-07-18 21:14:37 +01:00
parent d6a4b0fe22
commit 9b7df6b680
2 changed files with 6 additions and 30 deletions

View File

@@ -1,17 +1,14 @@
avr-calc
========
# Sinclair Scientific Calculator Emulator alternative software written in Rust
Alternative implementation for [Sinclair Scientific calculator](https://wiki.hexadust.net/books/electronics/page/sinclair-scientific-calculator-emulator-1974).
Alternative implementation for [Sinclair Scientific calculator](https://wiki.hexadust.net/books/electronics/page/sinclair-scientific-calculator-emulator-1974) board.
## Build Instructions
1. Install prerequisites as described in the [`avr-hal` README] (`avr-gcc`, `avr-libc`, `avrdude`, [`ravedude`]).
2. Run `cargo build` to build the firmware.
3. Run `cargo run` to flash the firmware to a connected board. If `ravedude` fails to detect your board, check its documentation at
2. Use `nightly-2024-03-22` toolchain.
2. Run `cargo build --release` to build the firmware (debug builds won't work for now).
3. Run `RAVEDUDE_PORT=/dev/ttyUSB0 cargo run --release` to flash the firmware to a connected board. If `ravedude` fails to detect your board, check its documentation at
<https://crates.io/crates/ravedude>.
4. `ravedude` will open a console session after flashing where you can interact with the UART console of your board.
[`avr-hal` README]: https://github.com/Rahix/avr-hal#readme
@@ -19,7 +16,7 @@ Alternative implementation for [Sinclair Scientific calculator](https://wiki.hex
## License
- ([LICENSE-MIT](LICENSE-MIT) or <http://opensource.org/licenses/MIT>)
- [LICENSE-APACHE](LICENSE-APACHE)
## Floating point support