Files
Reticulum-Go/README.md
2025-12-20 19:23:48 -06:00

57 lines
1.0 KiB
Markdown

# Reticulum-Go
A Go implementation of the [Reticulum Network Stack](https://github.com/markqvist/Reticulum).
## Goals
- To be fully compatible with the original Python implementation.
- Additional privacy and security features.
- Support for a broader range of platforms and architectures legacy and modern.
## Quick Start
### Prerequisites
- Go 1.24 or later
### Build
```bash
make build
```
### Run
```bash
make run
```
### Test
```bash
make test
```
## Embedded systems and WebAssembly
For building for WebAssembly and embedded systems, see the [tinygo branch](https://git.quad4.io/Networks/Reticulum-Go/src/branch/tinygo/). Requires TinyGo 0.37.0+.
Note: I am not actively working on webassembly support at the moment.
```bash
make tinygo-build
make tinygo-wasm
```
### Experimental Features
Build with experimental Green Tea GC (Go 1.25+):
```bash
make build-experimental
```
## Official Channels
- [Telegram](https://t.me/reticulum_go)
- [Matrix](https://matrix.to/#/#reticulum-go-dev:matrix.org)