andreil/katapult
1
0
Fork 0
mirror of https://github.com/andreili/katapult.git synced 2025-08-23 11:24:06 +02:00
Code Issues Packages Projects Releases Wiki Activity

readme: add contributing guidelines

Browse Source 
Fix a couple of minor documentation errors.

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
This commit is contained in:
Eric Callahan 2022-11-04 16:48:31 -04:00
parent 2990480d25
commit a89db2442e
No known key found for this signature in database
GPG Key ID: 5A1EB336DFB4C71B
2 changed files with 58 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -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 <uuid>
```
Replace <uuid> 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 <your email address>
```
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

37
developer-certificate-of-origin Normal file
View File

@ -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.