Skip to content

Commit

Permalink
2024/02/10 - Some project logistics for README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
FadiShawki committed Jan 10, 2024
1 parent 192029b commit 28cee3d
Show file tree
Hide file tree
Showing 4 changed files with 41 additions and 30 deletions.
27 changes: 21 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
24 changes: 0 additions & 24 deletions src/@orbitmines/README.md

This file was deleted.

11 changes: 11 additions & 0 deletions src/@orbitmines/external/chyp/Chyp.ts
Original file line number Diff line number Diff line change
@@ -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.
*/
9 changes: 9 additions & 0 deletions src/@orbitmines/external/chyp/README.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 28cee3d

Please sign in to comment.