aboutsummaryrefslogtreecommitdiffstats
path: root/users
diff options
context:
space:
mode:
authorGravatar Jack Humbert <jack.humb@gmail.com>2017-10-21 11:44:11 -1000
committerGravatar GitHub <noreply@github.com>2017-10-21 11:44:11 -1000
commit06f196c589b3c8c70c6cda6e95db6d1a2bf6e80b (patch)
treea346452e61bf8047d18c9a6d4863cc4ac63a5717 /users
parent9bb259b660925c7a5cd64b3a0a4484cdf757b504 (diff)
downloadqmk_firmware-06f196c589b3c8c70c6cda6e95db6d1a2bf6e80b.tar.gz
Creates a userspace for keymaps (#1559)
* create a user space * adds example * document, add readme.md * jackhumbert userspace, ergodox keymap
Diffstat (limited to 'users')
-rw-r--r--users/_example/_example.c5
-rw-r--r--users/_example/_example.h8
-rw-r--r--users/_example/readme.md14
-rw-r--r--users/_example/rules.mk1
-rw-r--r--users/jackhumbert/jackhumbert.c1
-rw-r--r--users/jackhumbert/jackhumbert.h6
-rw-r--r--users/jackhumbert/readme.md14
-rw-r--r--users/jackhumbert/rules.mk1
-rw-r--r--users/readme.md3
9 files changed, 53 insertions, 0 deletions
diff --git a/users/_example/_example.c b/users/_example/_example.c
new file mode 100644
index 000000000..8e0778b12
--- /dev/null
+++ b/users/_example/_example.c
@@ -0,0 +1,5 @@
+#include "_example.h"
+
+void my_custom_function(void) {
+
+} \ No newline at end of file
diff --git a/users/_example/_example.h b/users/_example/_example.h
new file mode 100644
index 000000000..f7c799025
--- /dev/null
+++ b/users/_example/_example.h
@@ -0,0 +1,8 @@
+#ifndef USERSPACE
+#define USERSPACE
+
+#include "quantum.h"
+
+void my_custom_function(void);
+
+#endif \ No newline at end of file
diff --git a/users/_example/readme.md b/users/_example/readme.md
new file mode 100644
index 000000000..fdea33b67
--- /dev/null
+++ b/users/_example/readme.md
@@ -0,0 +1,14 @@
+Copyright <year> <name> <email> @<github_username>
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>. \ No newline at end of file
diff --git a/users/_example/rules.mk b/users/_example/rules.mk
new file mode 100644
index 000000000..250adc3d0
--- /dev/null
+++ b/users/_example/rules.mk
@@ -0,0 +1 @@
+SRC += _example.c \ No newline at end of file
diff --git a/users/jackhumbert/jackhumbert.c b/users/jackhumbert/jackhumbert.c
new file mode 100644
index 000000000..011e0efb8
--- /dev/null
+++ b/users/jackhumbert/jackhumbert.c
@@ -0,0 +1 @@
+#include "jackhumbert.h" \ No newline at end of file
diff --git a/users/jackhumbert/jackhumbert.h b/users/jackhumbert/jackhumbert.h
new file mode 100644
index 000000000..69cfa6745
--- /dev/null
+++ b/users/jackhumbert/jackhumbert.h
@@ -0,0 +1,6 @@
+#ifndef USERSPACE
+#define USERSPACE
+
+#include "quantum.h"
+
+#endif \ No newline at end of file
diff --git a/users/jackhumbert/readme.md b/users/jackhumbert/readme.md
new file mode 100644
index 000000000..479a64140
--- /dev/null
+++ b/users/jackhumbert/readme.md
@@ -0,0 +1,14 @@
+Copyright 2017 Jack Humbert <jack.humb@gmail.com> @jackhumbert
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>. \ No newline at end of file
diff --git a/users/jackhumbert/rules.mk b/users/jackhumbert/rules.mk
new file mode 100644
index 000000000..f2981bb78
--- /dev/null
+++ b/users/jackhumbert/rules.mk
@@ -0,0 +1 @@
+SRC += jackhumbert.c \ No newline at end of file
diff --git a/users/readme.md b/users/readme.md
new file mode 100644
index 000000000..d8f14d8be
--- /dev/null
+++ b/users/readme.md
@@ -0,0 +1,3 @@
+# User space
+
+This is a place for users to put code that they might use between keyboards. If you build the keymap `mine`, `/users/mine/rules.mk` will be included in your build, and `/users/mine/` will be in your path - keep these things in mind when naming your files and referencing them from other places. \ No newline at end of file