commit 8b6c46cef26e97cc5cf820a3f0da0a385f2f5469 parent a8543c55e5fbfc29cc61501bfe7bd3b1f9e69bce Author: Pollux <pollux@pollux.codes> Date: Mon, 21 Jul 2025 13:26:28 -0500 docs: Add complete README.md Signed-off-by: Pollux <pollux@pollux.codes> Diffstat:
| M | README.md | | | 32 | ++++++++++++++++++++++++++++++-- |
1 file changed, 30 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md @@ -1,3 +1,31 @@ -# morph +# morph - xresources theme generator -*NOTE: This program is a work in progress.* +`morph` is an xresources theme generator. It takes a path to an image from +the command line and prints out an xresources file with colors extracted from +the image. This output can be piped into a file and loaded with `xrdb`, or +simply piped into `xrdb` directly. + +## Obtaining Sources + +The most recent sources can be obtained by cloning this repository. + +Archived versions of each stable release can be found under the +[refs page](/git/morph/refs.html). + +## Installation + +`morph` depends on +[imlib2](https://sourceforge.net/projects/enlightenment/files/imlib2-src/). + +Edit `config.mk` to your liking, then run (as root if necessary): + +```sh +make install +``` + +This will install the `morph` executable and the `morph.1` manpage to +the configured locations. + +## Usage + +See the man page (`man morph`) for details on usage.