diff options
author | lonkaars <loek@pipeframe.xyz> | 2021-10-08 14:27:57 +0200 |
---|---|---|
committer | lonkaars <loek@pipeframe.xyz> | 2021-10-08 14:27:57 +0200 |
commit | c2db0e3870041c1123f7066e2e4949eaefb2320a (patch) | |
tree | 6d6ce19e1f88a344d18e73548b9d1fd9d7a76ad9 | |
parent | 5e6f028deee172d70bbeaa60f5e6e61a99ff8e77 (diff) |
add readme and license
-rw-r--r-- | license | 21 | ||||
-rw-r--r-- | readme.md | 26 |
2 files changed, 47 insertions, 0 deletions
@@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2021 lonkaars + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..7ae7e48 --- /dev/null +++ b/readme.md @@ -0,0 +1,26 @@ +# avans-kluis + +(In Dutch) + +## Dingen die nog gedaan moeten worden + +- Code veranderen door de SET knop aan de binnenkant van de kluis in te drukken +- Index out of bounds crash wanneer er meer dan 1024 cijfers ingetoetst worden +- Heel misschien een grappige easter egg ofzo + +## Coole functies + +- Event-gebaseerde keyboard lezer +- Niet-blokkerende LED functie +- Overmatig veel gebruik van `#define` voor pinouts en alles +- Debounce correctie +- Code's die tot wel 1024 getallen lang kunnen zijn +- De enige blokkerende routine's zijn om de kluis te openen en te schreeuwen + tegen de gebruiker dat de code fout is +- Ongeveer zoveel commentaar als daadwerkelijke code +- Veel te ingewikkeld voor het 1e project + +De veiligheid van deze software is niet gegarandeerd, want als de Arduino +crasht of uitvalt wordt de code terug gezet op 0000. Dat maakt niet veel uit +want je kunt de kluis toch openen door hem een lichte ram te geven vanaf de +onderkant terwijl je hem open draait. |