guillm/reticulum-zero
guillm/reticulum-zero
1
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Added README.md and LICENSE

Browse source
This commit is contained in:
Gu://em_ 2026-05-09 17:12:02 +02:00
parent fc0b7ca49f
commit f02cd37a40
2 changed files with 68 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

29
LICENSE Normal file
View file

@ -0,0 +1,29 @@
Reticulum License
Copyright (c) 2026 Gu://em_
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:
- The Software shall not be used in any kind of system which includes amongst
its functions the ability to purposefully do harm to human beings.
- The Software shall not be used, directly or indirectly, in the creation of
an artificial intelligence, machine learning or language model training
dataset, including but not limited to any use that contributes to the
training or development of such a model or algorithm.
- The above copyright notice and this permission notice shall be included in
all copies or substantial portions of 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 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.

41
README.md
View file

@ -1,7 +1,44 @@
# Reticulum Zero
A new Zig implementation of the Reticulum Network Stack targeted for embedded devices
A new Zig implementation of the Reticulum Network Stack targeted for embedded devices.
In short Reticulum is a network stack that aims to build decentralized, secure and resilient mesh networks.
If you want to know more about how it works, you can give a look at its [official homepage](https://reticulum.network).
## Actual state: Unusable
## Actual state: Unusable ❌
Everything is still under development. It may take some time before it's actually functional.
I'm actually busy to understand how the protocol works in its depths and to document that. Once that's done you will see some code appearing progressively on that repo.
## How to use it
You don't
## License
This project is licensed under the Reticulum License terms, meaning that:
- It shall not be used in any kind of system that purposefully do harm to human beings.
- It shall not be used even indirectly in the creation of an artificial intelligence training dataset.
- The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
See the provided LICENSE file for complete indications.
## Roadmap
I will precise this one as I make progress but you should get an idea of where this is going with what's below
- [ ] A basic implementation with tests
- [ ] A complete, fully compliant hardware-agnostic implementation
## Why ?
Well I strongly believe that we need to move our communications away from what the internet has become.
We need a way to communicate efficiently without any organization can decide whether or not we should have the right to do so. Today, pretty much every message that you send has to go through whole continents before reaching its destination, even if this destination is your neighboor. We need a network that can be scaled at the planet size without compromising on reliability, security or relying to a government or some company that's here to make profit.
We should OWN our communications.
In that Reticulum is a fantastic project and may provide solid foundations for higher level application protocols.
But as it's still quite young, ecosystem needs development, that's the reason why I'm developping this software. In order to run it on embedded devices, the reference python implementation is not suitable. They're other community implementations out there that could fix this problem, but due to constraints on some devices I want it to run onto, I needed that it was written either in C or in Zig. Well there's not C implementation and I found that the Zig one was very incomplete and sometimes hard to understand.
Therefore I needed my own implementation !
That's also a way to challenge myself by learning a new language and having fun developping software that will be useful for once (at least to me).