aboutsummaryrefslogtreecommitdiff
path: root/README.org
diff options
context:
space:
mode:
Diffstat (limited to 'README.org')
-rw-r--r--README.org20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.org b/README.org
new file mode 100644
index 0000000..5ae8428
--- /dev/null
+++ b/README.org
@@ -0,0 +1,20 @@
+#+TITLE: edit-config
+
+This package aims at providing a convenient way of editing the various
+configuration files you have on your system.
+
+* Usage
+
+Customize the variable =edit-config-files=, it should the contain all the files
+you want to be able to jump to. Then, invoke =M-x edit-config=.
+
+* Installation
+
+This packages in not available in any common repository yet. You have to get it
+at https://tristanriehs.fr/git/edit-config.git. If you use
+[[https://github.com/radian-software/straight.el][straight]], you can use the following piece of configuration :
+
+#+begin_src emacs-lisp
+(straight-use-package 'create-license
+ :repo "https://tristanriehs.fr/git/edit-config.git")
+#+end_src