Skip to content

Commit

Permalink
Additional info for readme. (#146)
Browse files Browse the repository at this point in the history
* detail process for installing a module
  • Loading branch information
M4rkD authored and PuercoPop committed Nov 14, 2019
1 parent 03c964d commit d981d18
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.org
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 6 additions & 0 deletions util/notify/README.org
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit d981d18

Please sign in to comment.