Merge remote-tracking branch 'origin/master' into develop

3 files changed, 23 insertions, 30 deletions

diff --git a/users/drashna/pointing/pointing.c b/users/drashna/pointing/pointing.c
index 0198a8ae23..0bd14e4775 100644
--- a/users/drashna/pointing/pointing.c
+++ b/users/drashna/pointing/pointing.c
@@ -1,18 +1,5 @@
-/* Copyright 2020 Christopher Courtney, aka Drashna Jael're  (@drashna) <drashna@live.com>
- *
- * 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/>.
- */
+// Copyright 2021 Christopher Courtney, aka Drashna Jael're  (@drashna) <drashna@live.com>
+// SPDX-License-Identifier: GPL-2.0-or-later
 
 #include "pointing.h"
 
diff --git a/users/drashna/pointing/pointing.h b/users/drashna/pointing/pointing.h
index 4ad16eeff3..8b00ffc0ec 100644
--- a/users/drashna/pointing/pointing.h
+++ b/users/drashna/pointing/pointing.h
@@ -1,18 +1,5 @@
-/* Copyright 2020 Christopher Courtney, aka Drashna Jael're  (@drashna) <drashna@live.com>
- *
- * 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/>.
- */
+// Copyright 2021 Christopher Courtney, aka Drashna Jael're  (@drashna) <drashna@live.com>
+// SPDX-License-Identifier: GPL-2.0-or-later
 
 #include "drashna.h"
 
diff --git a/users/drashna/pointing/readme.md b/users/drashna/pointing/readme.md
new file mode 100644
index 0000000000..7770755050
--- /dev/null
+++ b/users/drashna/pointing/readme.md
@@ -0,0 +1,19 @@
+# User Pointing Device customization
+
+To disable the customized pointing device code and implement it at the keymap, add `CUSTOM_POINTING_DEVICE = no` to your `rules.mk`.
+
+## Automatic Mouse Layer
+
+Movement on the optical sensor triggers a layer that has all of the mouse keys on that layer.  After a set time, the layer will automatically turn itself off after 650ms.
+
+Also, using mousekeys will extend the amount of time that the layer will stay active. 
+
+Additionally, layer keys for the mouse layer will lock the layer on.
+
+## Gaming
+
+When the gamepad or diablo layers are enabled, the mouse layer is locked on, as well. 
+
+## Keycodes
+
+The only custom keycode for Pointing devices here is `KC_ACCEL`.  This allow the mouse report to have an acceleration curve (exponential).