aboutsummaryrefslogtreecommitdiff
path: root/README.org
diff options
context:
space:
mode:
Diffstat (limited to 'README.org')
-rw-r--r--README.org29
1 files changed, 22 insertions, 7 deletions
diff --git a/README.org b/README.org
index ce132b2..1d291e4 100644
--- a/README.org
+++ b/README.org
@@ -6,16 +6,31 @@ machine and allows you to quickly put them in your projects.
* Usage
-To interactively pull a stored license in the current directory, run
-=M-x create-license=. To initialize your license storage with the default
-license list, run =M-x create-license-download-common=. To customize the
-installed licenses, see =create-license-common=.
+First you have to initialize your license storage using =M-x
+create-license-download-common=. To customize the downloaded licenses list, see
+=create-license-common=. To interactively pull a license from the storage in
+the current directory, run =M-x create-license=. The licenses are stored under
+=create-license-directory=.
* Installation
-This packages in not available in any common repository yet. You have to get it
-at https://tristanriehs.fr/git/create-license.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/create-license, and load =create-license.el=.
+
+#+begin_src emacs-lisp
+(load "/path/to/create-license.el")
+#+end_src
+
+** [[https://github.com/radian-software/straight.el][Straight]]
#+begin_src emacs-lisp
(straight-use-package 'create-license