From 600c32b0d425d7c23c2810225a17708f95938698 Mon Sep 17 00:00:00 2001
From: vaxerski <43317083+vaxerski@users.noreply.github.com>
Date: Sun, 20 Mar 2022 18:02:20 +0100
Subject: [PATCH] update readme and config
---
README.md | 50 ++++++++++++++++++++++++++++++++++++++++---
example/hyprland.conf | 24 ++++++++++++++++-----
example/launch.json | 26 ++++++++++++++++++++++
3 files changed, 92 insertions(+), 8 deletions(-)
create mode 100644 example/launch.json
diff --git a/README.md b/README.md
index a9fa1364..2af58e59 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,51 @@
# Hyprland
-
-Hyprland is a Dynamic Tiling Wayland Compositor taking on some innovative and *groovin'* ideas. It's written fully in C++.
+*logo is a to-do :P*
+![Issues](https://img.shields.io/github/issues/vaxerski/Hyprland)
+![PRs](https://img.shields.io/github/issues-pr/vaxerski/Hyprland)
+![Lang](https://img.shields.io/github/languages/top/vaxerski/Hyprland)
+![License](https://img.shields.io/github/license/vaxerski/Hyprland)
+![Best](https://img.shields.io/badge/Standard-C%2B%2B20-success)
+![HiMom](https://img.shields.io/badge/Hi-mom!-ff69b4)
+
+Hyprland is a Dynamic Tiling Wayland Compositor in early development stages.
For Hyprland without the land part, see [Hypr](https://github.com/vaxerski/Hypr), the Xorg window manager.
-VERY early dev. And I mean VERY. It's yet to be really usable, but I am developing it!
\ No newline at end of file
+WARNING!
+Hyprland is in very early dev, expect bugs, instabilities and crashes. You have been warned!
+Nevertheless, REPORT any you find! Make an issue!
+
+
+# Key features
+ - Config reloaded instantly upon saving
+ - Easily expandable and readable codebase
+ - Support for docks/whatever
+ - Monitor rules
+ - Tiling/floating windows
+ - Moving/resizing windows
+
+
+# Major to-dos
+ - Animations
+ - Rounded corners
+ - Blur
+ - Window rules
+ - STABILITY
+
+
+# Installation
+Please refer to the [Wiki Page](https://github.com/vaxerski/Hyprland/wiki/Installation)
+
+
+# Configuring
+Head onto the [Wiki Page](https://github.com/vaxerski/Hyprland/wiki/Configuring-Hyprland) to see more.
+
+Hyprland without a config is a bad idea!
+
+
+# Gallery
+![Image1](https://i.imgur.com/SIPepse.png)
+
+
+# Contributions
+Welcome, I'll make a CONTRIBUTING.md some time in the future.
diff --git a/example/hyprland.conf b/example/hyprland.conf
index c10abe72..24793ea3 100644
--- a/example/hyprland.conf
+++ b/example/hyprland.conf
@@ -10,14 +10,28 @@ general {
max_fps=240
sensitivity=0.25
main_mod=SUPER
-
+
gaps_in=5
gaps_out=20
- border_size=1
+ border_size=2
col.active_border=0x66ee1111
col.inactive_border=0x66333333
}
-bind=SUPER,T,exec,xterm
-bind=SUPER,Q,killactive,
-bind=SUPERSHIFT,Q,exec,pkill Hyprland
\ No newline at end of file
+bind=SUPER,Q,exec,kitty
+bind=SUPER,C,killactive,
+bind=SUPER,M,exec,pkill Hyprland
+bind=SUPER,E,exec,dolphin
+bind=SUPER,V,togglefloating,
+bind=SUPER,R,exec,wofi --show drun -o DP-3
+
+bind=SUPER,1,workspace,1
+bind=SUPER,2,workspace,2
+bind=SUPER,3,workspace,3
+bind=SUPER,4,workspace,4
+bind=SUPER,5,workspace,5
+bind=SUPER,6,workspace,6
+bind=SUPER,7,workspace,7
+bind=SUPER,8,workspace,8
+bind=SUPER,9,workspace,9
+bind=SUPER,0,workspace,10
\ No newline at end of file
diff --git a/example/launch.json b/example/launch.json
new file mode 100644
index 00000000..c47bdb72
--- /dev/null
+++ b/example/launch.json
@@ -0,0 +1,26 @@
+{
+ // Use IntelliSense to learn about possible attributes.
+ // Hover to view descriptions of existing attributes.
+ // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+ "version": "0.2.0",
+ "configurations": [
+ {
+ "name": "(gdb) Launch",
+ "type": "cppdbg",
+ "request": "launch",
+ "program": "${workspaceFolder}/build/Hyprland",
+ "args": [],
+ "stopAtEntry": false,
+ "cwd": "${fileDirname}",
+ "externalConsole": false,
+ "MIMode": "gdb",
+ "setupCommands": [
+ {
+ "description": "Enable pretty-printing for gdb",
+ "text": "-enable-pretty-printing",
+ "ignoreFailures": true
+ }
+ ]
+ },
+ ]
+}
\ No newline at end of file