diff --git a/README.rst b/README.rst index 076b199..0f3c5c5 100644 --- a/README.rst +++ b/README.rst @@ -1,7 +1,17 @@ CH592 BLE HID Keyboard ====================== -The BLE/HID_Keyboard example from `openwch/ch592`_, -in its own repo so it's easier to build. +The BLE/HID_Keyboard example from the `openwch/ch592 `_ EVT, +in its own repo, with a ``Makefile`` and a ``shell.nix`` added +so it's easier to build without needing MounRiver Studio. -.. _openwch/ch592 https://github.com/openwch/ch592 +The ``shell.nix`` uses `the nix package manager `_, +and provides the MounRiver toolchain, as well as the newer ``riscv-none-elf-gcc`` xpack toolchain, and `wchisp `_. Enter the nix shell using either ``nix-shell``, or ``nix develop`` if using nix flakes. + +If not using nix, download either `MounRiver `_, or a more recent `xpack of riscv-none-elf-gcc `_. + +Run the ``Makefile`` using ``make``. + +The firmware can be flashed to the CH592 using ``wchisp``. (Enter the CH592 bootloader by holding down BOOT when connecting it using USB). + +The SDK for CH592 from the openwch EVT is vendored under ``sdk/``. (Encoding has been changed from gbk to utf-8).