aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMasaya Tojo <masaya@tojo.tokyo>2021-04-14 01:20:14 +0900
committerMasaya Tojo <masaya@tojo.tokyo>2021-04-14 03:07:32 +0900
commit3303155d3e787742aba948f31f894f615e98e180 (patch)
treea40c76df6742eeb533211ed564f333f70e0e6e3f
parentb9ccd1df08d76a412c6112357541318dc668d2b1 (diff)
Edit `README.md` file.
* README.md: Rename title from `extract-green-color` to `Extract-green-color`. [Requirements]: New section. [Installation]: New section. [Usage]: New section. [License]: New section.
-rw-r--r--README.md46
1 files changed, 45 insertions, 1 deletions
diff --git a/README.md b/README.md
index dea1206..e485558 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,47 @@
-# extract-green-color
+# Extract-green-color
Extract green color from a photo of LCD Writing Tablet.
+
+## Requirements
+
+* [GNU Guile](https://www.gnu.org/software/guile/) >= 2.2.7
+* [Guile-CV](https://www.gnu.org/software/guile-cv/index.html) >= 0.2.1
+
+## Installation
+
+### Install with Guix
+
+Add `tojo-tokyo` channel to `~/.config/guix/channels.scm`:
+
+ (cons* (channel
+ (name 'tojo-tokyo)
+ (url "https://git.tojo.tokyo/tojo-tokyo-guix-channel.git")
+ %default-channels)
+
+And proceed following:
+
+ guix pull
+ guix install extract-green-color
+
+### Install from the tarball
+
+To install from the tarball, proceed the following:
+
+ wget https://files.tojo.tokyo/extract-green-color/extract-green-color-1.0.0.tar.gz
+ tar xvf extract-green-color-1.0.0.tar.gz
+ cd extract-green-color
+ ./configure
+ make
+ make install
+
+## Usage
+
+To extract green color from `input.png` to `output.png`, proceed the following:
+
+ extract-green-color.scm input.png output.png
+
+To see more details, run `extract-green-color.scm --help`.
+
+## License
+
+GNU GPLv3+