aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorjohannst <johannes.stoelp@gmail.com>2020-09-29 21:20:43 +0200
committerjohannst <johannes.stoelp@gmail.com>2020-09-29 21:20:43 +0200
commitc445d128720e96adcdd12db9849f19fd60fca353 (patch)
tree147d30c2923ba17557f5163362670f10a9730ac7 /README.md
parent53be773e451776c8d820ec9218e79925ea3b5121 (diff)
downloadmatcha-threads-c445d128720e96adcdd12db9849f19fd60fca353.tar.gz
matcha-threads-c445d128720e96adcdd12db9849f19fd60fca353.zip
updated README
Diffstat (limited to 'README.md')
-rw-r--r--README.md39
1 files changed, 35 insertions, 4 deletions
diff --git a/README.md b/README.md
index cf865d0..f4702ac 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,43 @@
# matcha-threads
-A simple and unsafe implementation of cooperative-multitasking in userspace
-(see [fibers][fiber_wiki]).
+A simple and unsafe implementation of `cooperative-multitasking` in userspace
+(see [`fibers`][fiber_wiki]).
-`matcha-threads` were born after being bored and feeling low-"levelish".
+This implementation should not be used for anything serious, it was just
+created to type some lines of `asm` and filll a few evenings.
+
+Supported platforms are `Linux` running on
+- `x86_64`
+- `arm64`
+
+### Setup development environment
+This project provides a [`Dockerfile`](docker/Dockerfile) with all the required
+tools pre-installed.
+
+To build and launch a container instance run
+```bash
+make docker
+```
+> On the fist invocation this takes some minutes as it needs to build the
+> docker image.
+
+Additionally the locally cloned repository will be mounted into the container
+instance. This allows to use editors/tools installed on the host and to reduce
+the image disk footprint.
+
+### Build and run demo
+The `x86_64` demo can be run as
+```bash
+make demo1
+```
+The `arm64` demo can be run as
+```bash
+make ARCH=arm64 demo1
+```
+> Before starting to compile & run for a different architecture the the current
+> build artifacts should be removed via `make clean`.
## License
This project is licensed under the [MIT](LICENSE) license.
-
[fiber_wiki]: https://en.wikipedia.org/wiki/Fiber_(computer_science)