summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authoruntir_l <87096069+untir-l@users.noreply.github.com>2022-02-24 14:57:35 +0000
committeruntir-l <87096069+untir-l@users.noreply.github.com>2022-02-25 09:56:49 +0000
commitc23118e8e48d043e4bb9b4d813a498af8d454d73 (patch)
tree265947d2a848e8a3fb27106be38c8ae95b2fffe0 /README.md
parent8a7dde79de6edee01571d2eb4a333d8256f4c342 (diff)
downloadhitomezashi-c23118e8e48d043e4bb9b4d813a498af8d454d73.tar
hitomezashi-c23118e8e48d043e4bb9b4d813a498af8d454d73.tar.gz
hitomezashi-c23118e8e48d043e4bb9b4d813a498af8d454d73.zip
Add web app frontend, restructure almost everything
- Add web app frontend code - Add .html, .js, .wasm to .gitignore - Restructure Makefile to work with emmake, add build targets for web app, add .html, .js, .wasm to make clean - Explain the pattern in the README - Add explanation of web frontend to README - Restructure README generally for better clarity - Remove "make web app version" from todos in README - Set Doxygen to EXTRACT_ALL so trivial and useless doc comments are not needed when the naming suffices to be explanatory. - Move ascii_binary_str_to_ints to library code in new file hitomezashi_utils.c (and corresponding header) as web app also needs it. - Fix SDL2 include path so it also works with Emscripten - Remove some cluttering and unnecessary doc comments - Improve some doc comments
Diffstat (limited to 'README.md')
-rw-r--r--README.md41
1 files changed, 31 insertions, 10 deletions
diff --git a/README.md b/README.md
index 4488160..d611337 100644
--- a/README.md
+++ b/README.md
@@ -1,32 +1,53 @@
# Hitomezashi
-Library and CLI app to generate hitomezashi patterns like the following:
+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:
<img src="https://raw.githubusercontent.com/untir-l/hitomezashi/main/sample.png" alt="sample hitomezashi pattern" width="500" height="500">
-Inspired by [Numberphile's video](https://www.youtube.com/watch?v=JbfhzlMk2eY) on hitomezashi stitch patterns.
+## What is the pattern?
-Written in C11 with SDL2. Code style: whatever clang-format outputs.
+Consider a series of dashed lines, with alternating dashes and spaces of equal length. Let some number of these dashed lines emanate from the X axis, and some from the Y axis.
-Licensed under GPLv2 (see `LICENSE` file for full text). This project's source code is copyright © 2022-present Arjun Satarkar, except code contributed by others who retain their copyright.
+Now, assign a binary number to each of the lines on each axis. If the number is 0, let the first part of the line that is touching the axis be a dash, and the second a space. If it is 1, offset the dashed line by one part so it begins with a space, followed by a dash.
+
+The result is a hitomezashi pattern.
+
+For video explanation and to see one drawn to paper, check out [the video that inspired this project](https://www.youtube.com/watch?v=JbfhzlMk2eY).
-## Usage
+Hitomezashi patterns originated in Japan as a form of stitching. Thinking about the patterns as stitching helps explain the presence of what we approximate as dashed lines.
+
+## Building and usage
### libhitomezashi
This is in the `lib/` directory. For example usage, see the Hitomezashi CLI source (all the relevant code is in `main()`; most everything outside that is cumbersome argument parsing).
-Running `make` in the project root will build this as `libhitomezashi.a`.
+libhitomezashi can be compiled to WebAssembly for use on the web.
+
+To build, run `CC=gcc make libhitomezashi.a`.
### Hitomezashi CLI
-This is in the `cli/` directory. It is built by default when `make` is invoked in the project root. Run `./hitomezashi_cli -h` for usage info.
+This is in the `cli/` directory. Run `./hitomezashi_cli -h` for usage info.
+
+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.
-The output of the CLI app is a BMP image; you can convert it to something nicer like a PNG with FFmpeg or similar.
+To build, run `CC=gcc make hitomezashi_cli`.
-Additionally, the output is black and white - you can replace these colours using your tool of choice if desired.
+### Hitomezashi Web App
+
+Try it: *link pending upload*.
+
+To build, first run `make clean` if you previously built as native code, then (with Emscripten SDK in your PATH) run `emmake make hitomezashi_web.html`.
+
+## Technical and copyright information
+
+Written in C11 with SDL2. Code style: `make format-code` will run `clang-format` with the correct parameters.
+
+Licensed under GPLv2 (see `LICENSE` file for full text). This project's source code is copyright © 2022-present Arjun Satarkar, except code contributed by others who retain their copyright.
## Todos/potential future additions
-- Make a web app version
- Add support for output to PNG/other formats to the CLI app
- Add support for choosing foreground and background colours