Keymap: Velocikey implemented at userspace, readme is more helpful (#3974)

* deleting arkag branch, forcibly moving changes over to master

* fade_color function added, not tested

* added half functions some stuff

* surround_type function implemented and working.

* added flashing function and removed fading, flashing supports infinite flashing along with controlled number flashes

* added a fade state machine and functionality

* build optimizations, changed fade to bounce between bounds rather than roll over, added a HALMAK layout

* changes to sleep breath function, changed how I will switch to HALMAK

* support for halmak added

* support for activity detection added, condensed fading and flashing state machines, removed support for HALMAK and COLEMAK because arkag is stupid

* changed sleep and inactive behaviors, now the color shifting reverses on state change, yay! save_color and reset_color are made to enable layer color changing to look cooler.

* reformatted some if statements in state detection

* changes to force fade to pause on boot, or plug in.

* Attempting to move over to userspace, pushing to repository for help

* userspace stuff....

* userspace stuff....

* layout changes, working userspace,

Removed left side shift and replaced it with a MT() for LSFT and SPC. Userspace seems to be working properly now! HURRAY

* Layout change

Removed space/shift and reset modifiers to what they were originally. Added homerow modifiers.

* Removed excessive tabs in files

* Moved mods on homerow around...

* changes recommended by @drashna

* removed homerow mods, more flashy lighting!

* changed delays for lighting.

* velocikey code retro fit into userspace to match typing speed

currently "working" but isn't as reactive as I want.

* Readme and other documentation hidden throughout code

* Added a pretty picture

* pretty picture actually added

* More readme updates

* Velocikey now working inside my userspace!

* Changed repo macro and fixed readme

* Removed media layer, moved media control to LAZY layer

* fixed more merge issues when I had to merge...

1 files changed, 28 insertions, 0 deletions

diff --git a/users/arkag/readme.md b/users/arkag/readme.md
index 76a5c4525b..c685892f86 100644
--- a/users/arkag/readme.md
+++ b/users/arkag/readme.md
@@ -1,3 +1,26 @@
+# Shot on Pixel 2 XL with Cheap Lamp at Work
+
+![mmm, tasty](mechmini2.jpg)
+
+# I don't know what I'm doing
+
+Some links:
+* [Layout File: Mech Mini 2](layout_mm2)
+* [Userspace Header](arkag_h)
+* [Userspace Main](arkag_c)
+
+Here's a list of some things I have working with my currently [keyboard](mm2_home):
+
+* Reactive (sort of) fading while typing, ported from [Velocikey](https://github.com/qmk/qmk_firmware/pull/3754).
+* OS Switching, storing to EEPROM
+* OS Specific Macros and Shortcuts(WIN+SHIFT+S for Windows and CMD+SHIFT+4 for MacOS)
+* Flashing RGB LED on OS change
+* Hex Unicode Macros dependent on OS(half works on Windows due to [WinCompose](https://github.com/SamHocevar/wincompose) not functioning properly just yet).
+* "Sleep" function activates after 3 minutes (breathing).
+* Markdown style macros for surround type __eve__ ~~ryw~~ *her* **eee** (apparently only certain places support underline and strikethrough ಠ__ಠ)
+
+# License Stuff
+
 Copyright 2018 arkag arkag@pm.me
 
 This program is free software: you can redistribute it and/or modify
@@ -12,3 +35,8 @@ 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/>.
+
+[arkag_c]:    /users/arkag/arkag.c
+[arkag_h]:    /users/arkag/arkag.h
+[layout_mm2]: /keyboards/mechmini/v2/keymaps/arkag/keymap.c
+[mm2_home]:   https://cartel.ltd/projects/mechmini2/