aboutsummaryrefslogtreecommitdiff
path: root/incria/README.md
diff options
context:
space:
mode:
authortcmal <tcmal>2023-05-24 19:13:34 +0000
committerAria <me@aria.rip>2023-10-01 17:31:29 +0100
commit2c78bb68b9ff51cfb24ce1b7e111339ab5b37746 (patch)
tree6d33270f3bbf561343d9a300bc3dcede4518f115 /incria/README.md
parentf31fcefd85cb69f0c7aa8922f3a579a86eac415d (diff)
update name and write readme
Diffstat (limited to 'incria/README.md')
-rw-r--r--incria/README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/incria/README.md b/incria/README.md
new file mode 100644
index 0000000..01c8438
--- /dev/null
+++ b/incria/README.md
@@ -0,0 +1,9 @@
+# incria
+
+Incria is a library for incremental computation.
+It lets you record what a calculation depends on and then only re-run that calculation once one of those dependencies has changed.
+
+This is similar to the [query system used by the Rust compiler](https://rustc-dev-guide.rust-lang.org/query.html), but implemented using async.
+By seperating the tracking of dependencies from the calculation logic, you can write clean code that re-runs only when it needs to, and can be parallelised with little extra work.
+
+For more info, read the rustdoc or check the [/examples](examples).