Files
Reticulum-Go/README.md
Sudo-Ivan ea5c9147da
Some checks failed
Go Build Multi-Platform / build (amd64, linux) (push) Failing after 48s
Go Build Multi-Platform / build (amd64, freebsd) (push) Failing after 51s
Go Build Multi-Platform / build (amd64, windows) (push) Failing after 47s
Go Build Multi-Platform / build (amd64, darwin) (push) Failing after 53s
Go Build Multi-Platform / build (arm, freebsd) (push) Failing after 24s
Go Build Multi-Platform / build (arm, linux) (push) Failing after 36s
Go Build Multi-Platform / build (arm, windows) (push) Failing after 36s
Go Build Multi-Platform / build (arm64, darwin) (push) Failing after 35s
CodeQL Advanced / Analyze (go) (autobuild, go) (push) Failing after 39s
Go Build Multi-Platform / build (arm64, windows) (push) Failing after 41s
Go Build Multi-Platform / build (arm64, freebsd) (push) Failing after 57s
Go Build Multi-Platform / build (arm64, linux) (push) Failing after 44s
Go Test Multi-Platform / Test (ubuntu-latest, arm64) (push) Successful in 57s
Go Build Multi-Platform / Create Release (push) Has been skipped
Go Revive Lint / lint (push) Successful in 57s
Go Test Multi-Platform / Test (ubuntu-latest, amd64) (push) Successful in 1m18s
Run Gosec / tests (push) Successful in 1m24s
Go Test Multi-Platform / Test (macos-latest, amd64) (push) Has been cancelled
Go Test Multi-Platform / Test (windows-latest, amd64) (push) Has been cancelled
Go Test Multi-Platform / Test (macos-latest, arm64) (push) Has been cancelled
Update README
2025-12-20 19:19:45 -06:00

61 lines
1.1 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)
## Donations
See [donate.md](donate.md) for more information.