Additional info for readme. (#146)

* detail process for installing a module
This commit is contained in:
M4rkD 2019-11-14 04:00:38 +00:00 committed by Javier Olaechea
parent 03c964d004
commit d981d18af8
2 changed files with 15 additions and 0 deletions

View file

@ -64,6 +64,15 @@ From here you can commence hacking. When you're ready, advertise it
to the world!
[[http://www.xach.com/lisp/quickproject/][More docs here]].
** Loading a module
Loading a module can usually be done in your =~/.stumpwmrc= for a module =module-name= using:
#+begin_src lisp
(load-module "module-name")
#+end_src
Please see =README.org= files for each module for further details. Missing module dependencies, can be installed with:
#+begin_src lisp
(ql:quickload "notify")
#+end_src
* Third Party Modules
Advertise your module here, open a PR and include a org-mode link!
* Current Modules

View file

@ -34,6 +34,12 @@ Then you need to install the dev package:
apt-get install -y libfixposix-dev
#+END_SRC
** Testing
You can test notifications (if you have notify-send installed) with:
#+BEGIN_SRC sh
notify-send 'Hello world!' 'This is an example notification.'
#+END_SRC
* Footnotes
[fn:1] ...and possibly other distributions too