diff options
| author | Yuchen Pei <hi@ypei.me> | 2022-10-06 15:54:07 +1100 |
|---|---|---|
| committer | Yuchen Pei <hi@ypei.me> | 2022-10-06 15:54:07 +1100 |
| commit | fa9a801f816f609b0db04a66c623b0385dbaa005 (patch) | |
| tree | fd3626e5f89cbf5c2a9bb6350a190af79f27a063 /README.org | |
| parent | 5e72329d3a05aed027407bc6fb26d5363ae06530 (diff) | |
licensing and readme
Diffstat (limited to 'README.org')
| -rw-r--r-- | README.org | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/README.org b/README.org new file mode 100644 index 0000000..18e1797 --- /dev/null +++ b/README.org @@ -0,0 +1,30 @@ +#+title: luwak: a text-only Emacs web browser based on lynx -dump + +* Install and use + +Luwak mode is a simple Emacs GET-only and text-only web browser, based +on ~lynx -dump~. + +To use, clone this repo, add to ~load-path~ and ~require~. Make sure +you have lynx installed in your system (~apt install lynx~, ~pacman -S +lynx~ etc.). + +#+begin_src elisp +(add-to-list 'load-path "~/.emacs.d/luwak") +(require 'luwak) +#+end_src + +There are two entry points: + +- ~luwak-open~: open a url +- ~luwak-search~: search a query (default to ddg html) + +* Naming + +lynx dump -> feline excretion -> Kopi Luwak + +* Contact and Copyright + +luwak is maintained by Yuchen Pei (id@ypei.org). It is covered by [[https://www.gnu.org/licenses/agpl-3.0.en.html][GNU +AGPLv3+]]. You may find the license text in a file named COPYING.agpl3 +in the project tree. |