aboutsummaryrefslogtreecommitdiff
path: root/README.org
diff options
context:
space:
mode:
authorTristan Riehs <tristan.riehs@bordeaux-inp.fr>2024-11-02 19:26:23 +0100
committerTristan Riehs <tristan.riehs@bordeaux-inp.fr>2024-11-02 19:26:23 +0100
commit0e193945a4d6dc9b0915585f375642d1eedfed49 (patch)
tree532fc79d99a8809db5dba11ffa11147878d50c33 /README.org
parent43d727e71ad6839b70f22e7ea11a0637f39eebad (diff)
Improve documentation for publishing
Diffstat (limited to 'README.org')
-rw-r--r--README.org22
1 files changed, 18 insertions, 4 deletions
diff --git a/README.org b/README.org
index 5ae8428..15e8fe7 100644
--- a/README.org
+++ b/README.org
@@ -10,11 +10,25 @@ 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 :
+** My Package Archive
+
+I have my own package archive that you may use.
+
+#+begin_src emacs-lisp
+(add-to-list 'package-archives '("tr" . "https://tristanriehs.fr/elisp-packages/"))
+#+end_src
+
+** Manual
+
+Get the sources at https://tristanriehs.fr/git/edit-config, and load =edit-config.el=.
+
+#+begin_src emacs-lisp
+(load "/path/to/edit-config.el")
+#+end_src
+
+** [[https://github.com/radian-software/straight.el][Straight]]
#+begin_src emacs-lisp
-(straight-use-package 'create-license
+(straight-use-package 'edit-config
:repo "https://tristanriehs.fr/git/edit-config.git")
#+end_src