diff --git a/LICENSE-MIT b/LICENSE-MIT deleted file mode 100644 index 8aa2645..0000000 --- a/LICENSE-MIT +++ /dev/null @@ -1,21 +0,0 @@ -MIT License - -Copyright (c) [year] [fullname] - -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. diff --git a/README.md b/README.md index d9ed6f9..8842498 100644 --- a/README.md +++ b/README.md @@ -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 . - 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 ) +- [LICENSE-APACHE](LICENSE-APACHE) ## Floating point support