Better readme

5 files changed, 58 insertions, 18 deletions

diff --git a/config.h b/config.h
index d5ce7e8..91f5260 100644
--- a/config.h
+++ b/config.h
@@ -59,7 +59,7 @@ const char* qutebrowser[] = {"qutebrowser", NULL};
 const char* i3lock[] = {"i3lock", "-eti", "/usr/share/backgrounds/lockscreen.png", NULL};
 const char* suspend[] = {"systemctl", "suspend", NULL};
 
-#define MOD Mod1Mask
+#define MOD Mod4Mask
 #define SHIFT ShiftMask
 
 #define WSKEY(K, X) \
diff --git a/makefile b/makefile
index 621ee68..fc039da 100644
--- a/makefile
+++ b/makefile
@@ -16,6 +16,15 @@ $(EXEC): $(OBJS)
 $(OBJS_DIR)/%.o : $(SOURCE_DIR)/%.cpp
 	$(CXX) $(CXXFLAGS) -c $< -o $@
 
+i: $(EXEC)
+	sudo mv $(EXEC) /usr/bin
+	sudo cp yat.desktop /usr/share/xsessions
+install: i
+r:
+	sudo rm /usr/bin/$(EXEC)
+	sudo rm /usr/share/xsessions/yat.desktop
+remove: r
+
 #Files to be compiled
 $(OBJS_DIR)/main.o: $(SOURCE_FILES) $(SOURCE_HEADERS)
 $(OBJS_DIR)/ewmh.o: $(SOURCE_DIR)/ewmh.cpp $(SOURCE_DIR)/ewmh.h
diff --git a/readme.org b/readme.org
index d3faf61..9a9f321 100644
--- a/readme.org
+++ b/readme.org
@@ -1,33 +1,57 @@
 #+TITLE: YATwm
 #+OPTIONS: \n:t
+* This config is best read in emacs!
 
-* [WIP]
+* Disclaimer: This is still very much in beta
+This only just works, multiple monitors aren't supported and floating windows cannot move and there is no resizing. Many features are just hacked together and are likely to break. However, it is just about usable so if you really want to try then go for it! (feel free to make an issue if you have any questions).
 
-* Disclaimer: This is still very much before even beta or even a working state (it barely functions)
-It currently barely works (only reason this is public is because others may want to see for reference)
-I wouldn't suggest using this at all and it may undergo heavy changes as the code currently isn't very clean or good.
-
-* For people that have brain damage (anyone who wants to use it *while it is unfinished*)
+* Usage instructions
+** Installation
+*** Pre reqs
+- Xlib and g++ to build the program
+- Xephyr for the test script
+- Rofi, alacritty, picom, feh, polybar, qutebrowser and i3lock for the default config
+	- The current default config is currently just the configuration that I want to use (this will likely change)
+*** Installing and removing
+- ~make i~ or ~make install~ to install
+- ~make r~ or ~make remove~ to remove
+- ~./test~ to test
 ** Config
+The current default config is just my config.
 *** Startup
-Add a bash command to the ~startup~ string in config.h and it will execute on startup.
+Add a bash command to the ~startup~ string array in config.h and it will execute on startup.
 *** General
 You can change either the inner gaps (padding around each window - so double it for space between windows), or the outer gaps (padding around the display - add to inner gaps to get space between window and screen edges).
 They can be changed with the integers ~gaps~ and ~outerGaps~ in the config.h file.
 
-You can change the number of workspaces by editing ~numWS~ in the config.h file. You can think of workspaces as virtual desktops.
+You can change the number of workspaces by editing ~numWS~ in the config.h file, and the names by editing ~workspaceNames~. You can think of workspaces as virtual desktops.
 *** Keybinds
 Current keybinds: 
-- mod1 + enter	: alacritty
-- mod1 + d		: rofi
-- mod1 + t		: change next tile direction
-- mod1 + e		: exit
-- mod1 + q		: quit focused window
-- mod1 + (num)	: switch to workspace (num) - currently only for 1-5 but you can add more
-- mod1 + shift + (num)	: move window to workspace (num) - currently only for 1-5 but you can add more
-(mod1 is alt)
-Add new keybinds reffering to the pre existing ones - more docs coming later
+- mod + e					: exit
+- mod + enter				: alacritty
+- mod + d					: rofi
+- mod + t					: change next tile direction
+- mod + q					: quit focused window
+- mod + c					: qutebrowser
+- mod + x					: lock
+- mod + shift + x			: lock and sleep
+- mod + direction			: change focus in direction
+- mod + shift + directio	n	: move window in direction (currently not incredibly well implemented)
+- mod + (num)				: switch to workspace (num) - currently only for 1-10 but you can add more
+- mod + shift + (num)		: move window to workspace (num) - currently only for 1-10 but you can add more
+(mod is super, and the direction keys are h, j, k, l - left, down, up, right respectively like vim)
+
+To add new keybinds create a new entry in the keybind array:
+#+begin_source cpp
+{key,			modifiers,		command,		{commandArgs}},
+#+end_source
+e.g.
+#+begin_source cpp
+{XK_x,			MOD|SHIFT,		spawn,			{.str = i3lock}},
+#+end_source
+Commands are executed going down the list and multiple commands with the same keybind and modifiers will all be executed
 
 * Credits
 Catwm (https://github.com/pyknite/catwm)
+
 basic_wm (https://github.com/jichu4n/basic_wm)
diff --git a/run b/test
index 5427e8e..5427e8e 100644
--- a/run
+++ b/test
diff --git a/yat.desktop b/yat.desktop
new file mode 100644
index 0000000..81a424d
--- /dev/null
+++ b/yat.desktop
@@ -0,0 +1,7 @@
+[Desktop Entry]
+Encoding=UTF-8
+Name=YATwm
+Comment=Yet Another Tiling WM
+Exec=/usr/bin/YATwm
+Icon=YATwm
+Type=XSession