update readme

This commit is contained in:
Jeff Wang 2019-04-04 01:54:52 -04:00
parent 5e04a18cd2
commit a93bdd9c78

View File

@ -5,13 +5,18 @@ This is a replacement firmware for the [diyleyuan calculator](http://www.diyleyu
![calculator](./calc.jpg)
# Building
- The Makefile can be used for building the project to calculator.
- The Makefile can be used for building a new firmware for the calculator.
- type `make` to build
- (you must already have SDCC installed and setup so it can be found in your PATH)
- this will create a `main.hex` output file
- there is also a prebuilt binary checked in at `binaries/main.hex`
- CMakeLists.txt is for building the Qt desktop application.
- (still a work in progress, currently doesn't do anything)
- (still a work in progress)
- build similarly to other cmake projects:
- mkdir build_qt && cd build_qt
- cmake -DCMAKE_BUILD_TYPE=Debug -G "Eclipse CDT4 - Ninja" ..
- (you can choose a different generator, I prefer using Ninja to build, because it's fast)
- ninja
# Installing
The STC microcontroller used has a bootloader permanently stored in ROM that allows downloading new firmware over a serial port. You can re-program it using a USB-to-logic-level-serial (5V) dongle, and the stcgal program. WARNING: a lot of USB-to-logic-level-serial dongles are for 3.3V logic levels. The diyleyuan calculator runs at 5V to make it easier to power/drive the LCD display. You have a couple of options: