summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authoruntir_l <87096069+untir-l@users.noreply.github.com>2022-02-27 13:23:43 +0000
committeruntir_l <87096069+untir-l@users.noreply.github.com>2022-02-27 13:28:20 +0000
commit1ddd20748d01570929a88672366dff69ce300a51 (patch)
tree5c53f1765484427fc9334acfb7fa463c1d65b77b /README.md
parenta492064a97a04939ca5e995c3c6df4935b9e2cb9 (diff)
downloadhitomezashi-1ddd20748d01570929a88672366dff69ce300a51.tar
hitomezashi-1ddd20748d01570929a88672366dff69ce300a51.tar.gz
hitomezashi-1ddd20748d01570929a88672366dff69ce300a51.zip
Add support for choosing foreground and background colours
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 5 insertions, 2 deletions
diff --git a/README.md b/README.md
index 247ddc4..3d75887 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,7 @@
Library, CLI and web app to generate hitomezashi patterns. These are an example of visually complex and structured patterns arising from simple rules.
-Here is an example of such a pattern:
+Here is an example of such a pattern (different colours are also supported):
<img src="https://raw.githubusercontent.com/untir-l/hitomezashi/main/sample.png" alt="sample hitomezashi pattern" width="500" height="500">
@@ -32,6 +32,8 @@ To build, run `CC=gcc make libhitomezashi.a`.
This is in the `cli/` directory. Run `./hitomezashi_cli -h` for usage info.
+Colours are supported!
+
The output of the CLI app is a BMP image as this is supported by default in SDL2; this will change eventually to output PNGs since BMP is an antiquated format. For now, you can convert using FFmpeg or similar.
To build, run `CC=gcc make hitomezashi_cli`.
@@ -44,6 +46,8 @@ To build, first run `make clean` if you previously built to native code, then (w
You will need to serve, from a web server: `hitomezashi_web.html`, `hitomezashi_web.js`, `hitomezashi_web.wasm` in order for it to work; the `file://` protocol may not be sufficient.
+The UI is self-explanatory.
+
## Technical and copyright information
Written in C11 with SDL2. Code style: `make format-code` will run `clang-format` with the correct parameters.
@@ -52,4 +56,3 @@ Licensed under GPLv2 (see `LICENSE` file for full text). This project's source c
## Todos/potential future additions
- Add support for output to PNG/other formats to the CLI app
-- Add support for choosing foreground and background colours