update docs

This commit is contained in:
EatThePooh 2025-08-05 21:47:02 +07:00
parent 6abdf04412
commit 78baec82e3
4 changed files with 144 additions and 11 deletions

View file

@ -82,6 +82,8 @@ It consists primarily of the following components:
- [[#can-i-opt-out-of-nix][Can I opt out of Nix?]]
- [[#how-do-i-test-my-weave][How do I test my weave?]]
- [[#can-i-integrate-ai-models][Can I integrate AI models?]]
- [[#licensing][Licensing]]
- [[#how-it-works-1][How it works]]
* Inspiration
- [[https://github.com/enso-org/enso][Enso]]
@ -105,7 +107,7 @@ a CLI tool, an RPC server, or a web application, to be distributed as such or in
Powered by Nix, Grimu-R projects require minimal effort to build, run, or depend on.
For interactive use with scripts, the default mode is runtime dependencies.
For interactive use with scripts, the default mode is runtime dependency loading.
For builds, it is recommended to have dependencies defined statically and provisioned by Nix.
@ -131,7 +133,7 @@ Real code blocks in familiar languages are prioritized from day one, leveraging
Get started without implementing your own components.
No code to low code to high code.
Low code to high code.
* Non-goals
Some things Grimu-R itself will not take care of, delegating them to the surrounding environment:
@ -164,7 +166,7 @@ Below is a brief explanation for the key terms:
A Grimu-R project's weave is what changes when someone is working on it ("weaving").
It's a persistent representation of the dataflow graph and its graphic layout.
It's a persistent, Git-friendly representation of the dataflow graph and its graphic layout.
** Ornament
@ -291,3 +293,31 @@ There are three integration scenarios which would make sense:
#1 is easy to do even with no out-of-the-box support.
#2 and #3 would require some work on development tooling.
* Licensing
The Grimu-R platform components, including Loom development utilities and
the execution engine, are licensed under AGPL v3.
Base scrolls and other non-platform code are licensed under MIT.
** Repository Structure :noexport:
In this repository:
- Platform components are in the ~platform/~ directory
- Everything outside ~platform/~ falls under MIT licensing
- Full license texts are in ~LICENSE_PLATFORM~ and ~LICENSE_AMBIENT~
** Copyright and Contributions :noexport:
Copyright (C) 2025 Voleum
By contributing to this repository, you assign your copyright to Voleum under
the condition that your contribution will always remain available under the
original license terms specified above.
Alternative contribution arrangements may be available upon request.
** How it works
If you fork the platform and build a product on top of its code,
the fork MUST be licensed under AGPL v3 (or a more restrictive copyleft license),
even if it's a cloud product.
All other code can be used without restrictions.