add some documentation.

kiwanami · Feb 4, 2014 · 8f474bf · 8f474bf
1 parent 8b6fba6
commit 8f474bf
Show file tree

Hide file tree

Showing 4 changed files with 41 additions and 0 deletions.
diff --git a/img/app-list1.png b/img/app-list1.png
diff --git a/img/detail1.png b/img/detail1.png
diff --git a/img/home1.png b/img/home1.png
diff --git a/readme.md b/readme.md
@@ -0,0 +1,41 @@
+# Portage Navi
+
+This program is a frontend GUI for portage, the great package manager.
+
+The current status is under construction. Just viewing portage database.
+
+[Home Buffer]
+![Home](./img/home1.png)
+
+[Category List Buffer]
+![Category List](./img/app-list1.png)
+
+[Package Detail Buffer]
+![Package Detail](./img/detail1.png)
+
+# Installation
+
+## Package Installation
+
+From MELPA, you can install this package as `portage-navi`.
+
+## Manual Installation
+
+Place `portage-navi.el`, `deferred.el`, `concurrent.el` and `ctable.el` in your load path and add following code.
+
+```lisp
+(require 'portage-navi)
+```
+
+Then, try `M-x pona:open-home-buffer`.
+
+# Usage
+
+TODO
+
+# License
+
+Portage Navi is licensed under GPL v3.
+
+----
+(C) 2014 SAKURAI Masashi. m.sakurai at kiwanami.net