This repository has been archived by the owner on Apr 27, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
77 changed files
with
36 additions
and
4,801 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +0,0 @@ | ||
[submodule "Orca"] | ||
path = Orca | ||
url = https://github.com/metasyn/Orca | ||
[submodule "Enfer"] | ||
path = Enfer | ||
url = https://github.com/metasyn/Enfer | ||
Submodule Enfer
deleted from
68eb59
Submodule Orca
deleted from
778e9b
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,96 +1,11 @@ | ||
# learn-orca | ||
# Give Up GitHub | ||
|
||
learn-orca is a site for learning how to use [Orca](https://100r.co/site/orca.html). | ||
This project has given up GitHub. ([See Software Freedom Conservancy's _Give Up GitHub_ site for details](https://GiveUpGitHub.org).) | ||
|
||
# developing | ||
You can now find this project at [learn-orca on sourcehut](https://git.sr.ht/~metasyn/learn-orca) instead. | ||
|
||
Requires [pandoc](https://pandoc.org) | ||
Any use of this project's code by GitHub Copilot, past or present, is done without our permission. We do not consent to GitHub's use of this project's code in Copilot. | ||
|
||
``` | ||
git submodule update | ||
``` | ||
Join us; you can [give up GitHub](https://GiveUpGitHub.org) too! | ||
|
||
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`. | ||
|
||
# adding sections | ||
|
||
Simply update `sections.md` and run `make pandoc`. | ||
|
||
# adding operators | ||
|
||
Operators are in `js/main.js`. Each operator specifies some rows, inputs, and outputs. | ||
|
||
# contributing | ||
|
||
- 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-[email protected] | ||
|
||
# license | ||
|
||
``` | ||
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/> | ||
``` | ||
![Logo of the GiveUpGitHub campaign](https://sfconservancy.org/img/GiveUpGitHub.png) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.