aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNicholas Tay <nick@windblume.net>2022-05-25 18:01:48 +1000
committerNicholas Tay <nick@windblume.net>2022-05-25 18:04:25 +1000
commit229d43bd90283c5925a9f6972f97d44022c768ed (patch)
tree10fce8a2621836a0a9e82cf405bdf8c8094fd426
parentc961bcd3b7286b3e18fded3c876a8b7770d67cc8 (diff)
downloadclak-229d43bd90283c5925a9f6972f97d44022c768ed.tar.gz
clak-229d43bd90283c5925a9f6972f97d44022c768ed.tar.bz2
clak-229d43bd90283c5925a9f6972f97d44022c768ed.zip
Add goals + licence to README
Diffstat (limited to '')
-rw-r--r--LICENCE2
-rw-r--r--README.md16
2 files changed, 17 insertions, 1 deletions
diff --git a/LICENCE b/LICENCE
index 276ca76..ca0c7d8 100644
--- a/LICENCE
+++ b/LICENCE
@@ -1,4 +1,4 @@
-BSD 2-Clause License
+BSD 2-Clause Licence
Copyright (c) 2022, Nicholas Tay <nick@windblume.net>.
All rights reserved.
diff --git a/README.md b/README.md
index 5338d33..f9571cd 100644
--- a/README.md
+++ b/README.md
@@ -10,6 +10,18 @@ $ ./clak <board name>
That's it.
+## Goals
+
+- [ ] Cross-platform
+ - [x] Windows
+ - [ ] Linux
+ - Half complete. Would like to clean up and even not use SDL if possible
+ - [ ] macOS
+- [ ] Dynamically extensible
+ - Load plugins via dll/so/dylib
+- [ ] Allow passing of keystrokes in standard format
+ - [ ] Warn user if we are capturing keystrokes to the plugin
+
## Requirements
Should work on Windows and Linux.
@@ -60,3 +72,7 @@ To build the boards:
$ cd board
$ make
```
+
+## Licence
+
+[BSD 2-Clause](./LICENCE)