diff --git a/README.md b/README.md index 1cc73d5..32010e7 100644 --- a/README.md +++ b/README.md @@ -66,7 +66,8 @@ configured an alternative method of entry. ## Uploading Klipper 1) Make sure the `klipper` service stopped. -2) Build Klipper with CAN support and with the "8KiB" bootloader setting enabled. +2) Build Klipper with CAN support and with the a bootloader offset matching that + of the "application offset" in CanBoot. 3) Enter the bootloader. This will occur automatically if no program is detected. If you built CanBoot with an alternative method of entry you may use that. If upgrading from a currently flashed version of Klipper the `flash_can.py` @@ -75,7 +76,7 @@ configured an alternative method of entry. 3) Run the flash script: For CAN Devices: ``` - cd ~/CanBoot + cd ~/CanBoot/scripts python3 flash_can.py -i can0 -f ~/klipper/out/klipper.bin -u ``` Replace with the appropriate uuid for your can device. If @@ -150,6 +151,24 @@ version of CanBoot, etc). Once complete, the deployer should reset the device and enter CanBoot. Now you are ready to use CanBoot to flash an application, such as Klipper. +## Contributing + +CanBoot is effectively a fork of Klipper's MCU source. As such, it is appropriate +to retain similar contributing guidelines as Klipper. Commits should be formatted +as follows: + +``` +filename: brief description of commit + +More detailed explanation of the change if required. + +Signed-off-by: Your Name +``` + +All commits must be signed off with a real name and email address indicating +acceptance of the +[developer certificate of origin](/developer-certificate-of-origin). + ## Notes - It is recommended to USB CAN device flashed with [candlelight](https://github.com/candle-usb/candleLight_fw), such as a diff --git a/developer-certificate-of-origin b/developer-certificate-of-origin new file mode 100644 index 0000000..8201f99 --- /dev/null +++ b/developer-certificate-of-origin @@ -0,0 +1,37 @@ +Developer Certificate of Origin +Version 1.1 + +Copyright (C) 2004, 2006 The Linux Foundation and its contributors. +1 Letterman Drive +Suite D4700 +San Francisco, CA, 94129 + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. + + +Developer's Certificate of Origin 1.1 + +By making a contribution to this project, I certify that: + +(a) The contribution was created in whole or in part by me and I + have the right to submit it under the open source license + indicated in the file; or + +(b) The contribution is based upon previous work that, to the best + of my knowledge, is covered under an appropriate open source + license and I have the right under that license to submit that + work with modifications, whether created in whole or in part + by me, under the same open source license (unless I am + permitted to submit under a different license), as indicated + in the file; or + +(c) The contribution was provided directly to me by some other + person who certified (a), (b) or (c) and I have not modified + it. + +(d) I understand and agree that this project and the contribution + are public and that a record of the contribution (including all + personal information I submit with it, including my sign-off) is + maintained indefinitely and may be redistributed consistent with + this project or the open source license(s) involved.