From 28cee3dfe9dbd429ea762dd5aad34d10b7bbfbeb Mon Sep 17 00:00:00 2001 From: Fadi Shawki Date: Wed, 10 Jan 2024 16:02:19 +0100 Subject: [PATCH] 2024/02/10 - Some project logistics for README.md --- README.md | 27 +++++++++++++++++++------ src/@orbitmines/README.md | 24 ---------------------- src/@orbitmines/external/chyp/Chyp.ts | 11 ++++++++++ src/@orbitmines/external/chyp/README.md | 9 +++++++++ 4 files changed, 41 insertions(+), 30 deletions(-) delete mode 100644 src/@orbitmines/README.md create mode 100644 src/@orbitmines/external/chyp/README.md diff --git a/README.md b/README.md index f0a49ec..46f544e 100644 --- a/README.md +++ b/README.md @@ -7,15 +7,30 @@ --- -#### Discussion +**What is this?, What is OrbitMines?, What are Rays?** -Feel free to discuss this project on this GitHub repository or preferably the [OrbitMines Community Discord](https://discord.orbitmines.com). +A simple way of phrasing this, is that the concept of a (hyper-/)'Vertex', (hyper-/)'Edge', (hyper-/)'Graph', (hyper-/)'Rule', (hyper-/)'Tactic', (hyper-/)..., (hyper-/)'Rewrite' are merged into one thing: a [Ray](https://github.com/orbitmines/orbitmines.com/blob/main/src/%40orbitmines/explorer/Ray.ts). It handles surrounding context, ignorances, equivalences, ..., differentiation. (And if it cannot, then it offers a way of implementing it for all of the above) + +- If you prefer **text**, see [2023-12-31. On Orbits, Equivalence and Inconsistencies](https://orbitmines.com/papers/on-orbits-equivalence-and-inconsistencies), or more generally my/OrbitMines writing can be found here: [orbitmines.com/profiles/fadi-shawki](https://orbitmines.com/profiles/fadi-shawki). + + +- If you prefer **audio-visual mumblings**, see [2024-01-04. What is OrbitMines?, Implementing Aleks Kissinger's Chyp and maybe looking at Tinygrad](https://www.youtube.com/watch?v=O6v_gzlI1kY), or more generally my streams can be found here: [youtube.com/@FadiShawki/streams](https://www.youtube.com/@FadiShawki/streams). + + +- If you prefer **archaic symbolics: i.e. code**, see [Ray.ts](https://github.com/orbitmines/orbitmines.com/blob/main/src/%40orbitmines/explorer/Ray.ts) (or locally: [local/Ray.ts](./src/@orbitmines/explorer/Ray.ts)), or more generally my/OrbitMines code can be found here [github.com/orbitmines](https://github.com/orbitmines/). + + +- If you prefer discussions on **Discord**: [discord.orbitmines.com](https://discord.orbitmines.com). + + +- Or if prefer smashing your keyboard till there's something interesting on the screen. See a first implementation of this *explorational interface*: [orbitmines.com/explorer/github.com/akissinger/chyp](https://orbitmines.com/explorer/github.com/akissinger/chyp). --- -#### Latest Writing - Some context on this project +### Some general notes about this project -[2023-12-31. On Orbits, Equivalence and Inconsistencies](http://orbitmines.com/papers/on-orbits-equivalence-and-inconsistencies/ -) -![on-orbits-equivalence-and-inconsistencies](public/papers/on-orbits-equivalence-and-inconsistencies/images/thumbnail/3840x2160.jpeg) +> [!IMPORTANT] +> Anything in this directory should be considered as deprecated. It is merely used as the initial (crude) bootstrap for OrbitMines. And will surely be replaced at some point - it is not (yet) meant as a formal spec. +> [!WARNING] +> No proper security audit has yet been done on its current iteration. diff --git a/src/@orbitmines/README.md b/src/@orbitmines/README.md deleted file mode 100644 index 51c6d99..0000000 --- a/src/@orbitmines/README.md +++ /dev/null @@ -1,24 +0,0 @@ -![orbitmines.logo.3000x1000.png](..%2Flib%2Forganizations%2Forbitmines%2Flogo%2Forbitmines.logo.3000x1000.png) - -# OrbitMines -*An explorational interface.* - ---- - -> [!IMPORTANT] -> Anything in this directory should be considered as deprecated. It is merely used as the initial (crude) bootstrap for OrbitMines. And will surely be replaced at some point - it is not meant as a formal spec. - ---- - -## Contributing & Discussion - -Feel free to discuss this project on this GitHub repository or preferably the [OrbitMines Community Discord](https://discord.orbitmines.com). - ---- - -## Security - -> [!WARNING] -> No proper security audit has yet been done on its current iteration (TODO: link to thread for contributions & discussions). - ---- \ No newline at end of file diff --git a/src/@orbitmines/external/chyp/Chyp.ts b/src/@orbitmines/external/chyp/Chyp.ts index e69de29..ebfc02b 100644 --- a/src/@orbitmines/external/chyp/Chyp.ts +++ b/src/@orbitmines/external/chyp/Chyp.ts @@ -0,0 +1,11 @@ +/** + * An interface from Aleks Kissinger's [Chyp (Cospans of HYPergraphs)](https://github.com/akissinger/chyp) to (OrbitMines') Rays. + * + * **What is this?, What are Rays?** + * + * See the `README.md` at [github.com/orbitmines/orbitmines.com](https://github.com/orbitmines/orbitmines.com). Or locally: [README.md](../../../../README.md) + * + * **Why is this interface here?** + * + * Note that this is mainly here for reference to the existing Chyp codebase - for anyone who understands that structure, to quickly translate that knowledge into how Rays work. - Other than that functionality, everything here should be considered as deprecated. Or considered as a legacy translation, which will be accessibly through OrbitMines. + */ \ No newline at end of file diff --git a/src/@orbitmines/external/chyp/README.md b/src/@orbitmines/external/chyp/README.md new file mode 100644 index 0000000..ddcfbd3 --- /dev/null +++ b/src/@orbitmines/external/chyp/README.md @@ -0,0 +1,9 @@ +An interface from Aleks Kissinger's [Chyp (Cospans of HYPergraphs)](https://github.com/akissinger/chyp) to (OrbitMines') Rays. + +**What is this?, What are Rays?** + +See the `README.md` at [github.com/orbitmines/orbitmines.com](https://github.com/orbitmines/orbitmines.com). Or locally: [README.md](../../../../README.md) + +**Why is this interface here?** + +Note that this is mainly here for reference to the existing Chyp codebase - for anyone who understands that structure, to quickly translate that knowledge into how Rays work. - Other than that functionality, everything here should be considered as deprecated. Or considered as a legacy translation, which will be accessibly through OrbitMines. \ No newline at end of file