gh-5 misc: Merge pull request #6 from AlexandruIca/gh-5-Add-README-and-LICENSE

AlexandruIca · web-flow · commit ee148dd8c3e7 · 2021-08-01T22:34:52.000+03:00
gh-5 Add README and LICENSE
diff --git a/LICENSE.md b/LICENSE.md
@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <http://unlicense.org/>
diff --git a/README.md b/README.md
@@ -0,0 +1,38 @@
+# Monads in C++
+Using coroutines we can say something like:
+```cpp
+auto f() -> result<int, std::string>
+{
+    return "Error!";
+}
+
+auto g() -> result<int, std::string>
+{
+    return 5;
+}
+
+auto compute() -> result<int, std::string>
+{
+    int const a = co_await f();
+    int const b = co_await g();
+
+    co_return a + b;
+}
+```
+
+# What? Why?
+I think there's only two possible reactions to this, no in-between:
+ * WTF is this?
+ * Such a shame there is no direct support from the language for something like this
+
+# Building
+There is a `shell.nix` that gives you an environment with all the stuff needed to run this "project"(though you don't need nix, it's just convenient to use). If you have nix you can:
+```sh
+nix-shell
+
+./scripts/build.sh
+```
+And then in `build/src/` you can run `./cpp-monads`.
+
+# Resources
+Most of this was inspired from [here](https://www.reddit.com/r/cpp/comments/6ly4rz/it_had_to_be_done_abusing_co_await_for_optionals/) and [here](https://cpp-rendering.io/c-error-handling-lets-abuse-the-co_await-operator/).
