Add a "design philosophy" doc migrated from the wiki

pull/848/head^2
Jesse Vincent 5 years ago
parent 0a103d1568
commit ca06492a89
No known key found for this signature in database
GPG Key ID: CC228463465E40BC

@ -0,0 +1,9 @@
Kaleidoscope should, in order:
1) Work well as a keyboard
2) Be compatible with real hardware
3) Be compatible with the spec
4) Be easy to read and understand
5) Be easy to modify and customize
Our code indentation style is managed with 'make astyle.' For code we 'own', there should be an astyle target in the Makefile. For third party code we use and expect to update (ever), we try not to mess with the upstream house style.

@ -52,6 +52,7 @@ Understanding the codebase
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
codebase/design-philosophy.md
codebase/glossary.md codebase/glossary.md
codebase/code-style.md codebase/code-style.md

Loading…
Cancel
Save