From 3303155d3e787742aba948f31f894f615e98e180 Mon Sep 17 00:00:00 2001 From: Masaya Tojo Date: Wed, 14 Apr 2021 01:20:14 +0900 Subject: 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. --- README.md | 46 +++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 45 insertions(+), 1 deletion(-) 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+ -- cgit v1.2.3