summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--.gitignore4
-rw-r--r--README.md13
2 files changed, 16 insertions, 1 deletions
diff --git a/.gitignore b/.gitignore
index 291b6e1..7438dc1 100644
--- a/.gitignore
+++ b/.gitignore
@@ -2,4 +2,6 @@
!.gitignore
!init.el
-!theme.el \ No newline at end of file
+!theme.el
+!README.md
+
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c206628
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+# Emacs.d
+
+This is my emacs configuration. It aims to be *simple* and *lean*
+
+## Notes
+
+This setup is tested on Emacs 30.1, this means some packages are already built-in, such as:
+
+- `use-package`
+- `eglot`
+
+Additionally the theme custom module assumes you are running Gnome
+