aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.org22
-rw-r--r--edit-config.el28
2 files changed, 33 insertions, 17 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
diff --git a/edit-config.el b/edit-config.el
index 7f54d99..ab45b39 100644
--- a/edit-config.el
+++ b/edit-config.el
@@ -3,6 +3,7 @@
;; Copyright (C) 2024 Tristan Riehs
;; Author: Tristan Riehs <tristan.riehs@bordeaux-inp.fr>
+;; Maintainer: Tristan Riehs <tristan.riehs@bordeaux-inp.fr>
;; Keywords: convenience
;; This program is free software; you can redistribute it and/or modify
@@ -20,9 +21,11 @@
;;; Commentary:
-;; This package aims at providing a convenient way of editing the various
-;; configuration files you have on your system. The main thins you should
-;; be interested in are `edit-config-files' and `edit-config'.
+;; This package aims at providing a convenient way of editing the
+;; various configuration files you have on your system.
+
+;; You should first customize `edit-config-files', and then use M-x
+;; `edit-config'.
;;; Code:
(defgroup edit-config nil
@@ -65,16 +68,15 @@ Used when prompting only when `edit-config-missing' is non-nil. See
(defun edit-config (label)
"Edit the config file associated to LABEL."
(interactive
- (list (if edit-config-files
- (completing-read "Config: "
- edit-config-files
- (if edit-config-missing
- 'edit-config--completing-read-predicate
- nil)
- t
- nil
- 'edit-config--hist)
- nil)))
+ (list (when edit-config-files
+ (completing-read "Config: "
+ edit-config-files
+ (if edit-config-missing
+ 'edit-config--completing-read-predicate
+ nil)
+ t
+ nil
+ 'edit-config--hist))))
(if label
(find-file (alist-get label edit-config-files nil nil 'string-equal))
(message "No config file to propose, have you you customized \