diff --git a/LICENSE b/LICENSE index 24b68f0..68a49da 100644 --- a/LICENSE +++ b/LICENSE @@ -1,7 +1,24 @@ -Copyright 2020 @metasyn +This is free and unencumbered software released into the public domain. -Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: +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. -The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. +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 ARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS 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. +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 diff --git a/README.md b/README.md index 5cc3a51..530ec2f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # learn-orca -learn-orca is a site for learning how to use [Orca](https://github.com/hundredrabbits/Orca). +learn-orca is a site for learning how to use [Orca](https://100r.co/site/orca.html). # developing @@ -13,32 +13,40 @@ git submodule update This site uses pandoc to convert markdown to html. The html is then loaded via an iframe. To make/update the sections: + ``` make pandoc ``` To make/update the examples (requires python3): + ``` make examples ``` If you're developing, you can run: + ``` make serve ``` + to start a simple web server for testing (requires python3). You can run: + ``` make watch ``` + to automatically call pandoc on files changes. This requires [fswatch](https://github.com/emcrisostomo/fswatch). Formatting and linting - If you have eslint and prettier installed, you can run: + ``` make format make lint ``` + which should help you find bugs/issues in the code. You can install them with `npm install`. @@ -52,13 +60,37 @@ Operators are in `js/main.js`. Each operator specifies some rows, inputs, and ou # contributing -* make changes -* run `make pandoc` if needed -* run the linter and formatter -* does the site load? do examples load? -* make a PR! - +- make changes +- run `make pandoc` if needed +- run the linter and formatter +- does the site load? do examples load? +- use [git-send-email](https://git-send-email.io) to send a patch to ~metasyn/public-inbox@lists.sr.ht # license -MIT +``` +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 +```