search

panda-official / TimeSwipe

PANDA Timeswipe driver and firmware
GNU General Public License v3.0
3 stars 5 forks source link

Create modern Readme #12

Closed IngoKaiser closed 2 years ago

IngoKaiser commented 4 years ago

TimeSwipe_3_no stroke

Example attached.

image

Who wants to do it?

IngoKaiser commented 4 years ago

PANDA Timeswipe (all black)

With title like this ... I just think without logo and PANDA :)

IngoKaiser commented 4 years ago

Perhaps we can integrate Subheaders like:

Install -> link to readme for building drivers for several os

Documentation -> link to firmware doc -> link to communication protocol doc -> link to driver doc

RPi Examples -> link to Rpi examples

Customizing Firmware -> link to building and flashing firmware -> link to firmware examples

License

Other ideas for Main Readme really appreciated. Also about other readme files -> have them in according repo or together in docs dir?

Please give me feedback on that @iluxa @begodev

pmalessa commented 4 years ago

Driver Documentation Generation from Doxygen: example: https://phoggy.github.io/TimeSwipe/annotated.html have a look at my fork of TimeSwipe: https://github.com/PhoGGy/TimeSwipe/blob/doxygen/.github/workflows/main.yml This is a working Github Action to build the Doxygen Documentation from every push and upload it to the gh-pages branch, from where it gets automatically deployed to GitHub.io