doc: add README 📝

WarFox · Apr 16, 2024 · 6c41d55 · 6c41d55
1 parent 066d7a5
commit 6c41d55
Showing 1 changed file with 38 additions and 0 deletions.
diff --git a/README.org b/README.org
@@ -0,0 +1,38 @@
+#+title: Warmacs
+
+Emacs configuration heavily inspired by Doom and Spacemacs. Built for macOS and emacs version =30.0.5=
+
+* Core Principles
+
+** Speed
+
+No comproise on speed, gotta go fast.
+
+** Mnemonic Key Bindings
+
+All keybindings follow =mnemonic= pattern like Spacemacs.
+
+** Discoverable
+
+Great help features and documents.
+
+** Consistency
+
+No surprises, consistent workflow everywhere.
+
+** UX
+
+Consistent UX built around the capabilities of =use-package=, =elpaca.el=, =general.el=, =evil=, =consult=.
+
+** Evil
+
+Vim key bindings for you!
+
+** Programming
+
+Start programming in your favourite language right away. Supports
+=lsp= and =tree-sitter= out of the box for you programming experience.
+
+* License
+
+The license is GPLv3 for all parts specific to Warmacs.