Update README
This commit is contained in:
31
README.md
31
README.md
@@ -5,31 +5,46 @@ A Go implementation of the [Reticulum Network Stack](https://github.com/markqvis
|
||||
## 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.
|
||||
- Additional privacy and security features.
|
||||
|
||||
## Quick Start
|
||||
## Development
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- Go 1.24 or later
|
||||
- [go-task](https://taskfile.dev/)
|
||||
|
||||
Might need `alias task='go-task'` in your shell to use it as `task` instead of `go-task`.
|
||||
|
||||
### Build
|
||||
|
||||
```bash
|
||||
make build
|
||||
task build
|
||||
```
|
||||
|
||||
### Run
|
||||
|
||||
```bash
|
||||
make run
|
||||
task run
|
||||
```
|
||||
|
||||
### Test
|
||||
|
||||
```bash
|
||||
make test
|
||||
task test
|
||||
```
|
||||
|
||||
### Format Code
|
||||
|
||||
```bash
|
||||
task fmt
|
||||
```
|
||||
|
||||
### Run All Checks
|
||||
|
||||
```bash
|
||||
task check
|
||||
```
|
||||
|
||||
## Embedded systems and WebAssembly
|
||||
@@ -39,8 +54,8 @@ For building for WebAssembly and embedded systems, see the [tinygo branch](https
|
||||
Note: I am not actively working on webassembly support at the moment.
|
||||
|
||||
```bash
|
||||
make tinygo-build
|
||||
make tinygo-wasm
|
||||
task tinygo-build
|
||||
task tinygo-wasm
|
||||
```
|
||||
|
||||
### Experimental Features
|
||||
@@ -48,7 +63,7 @@ make tinygo-wasm
|
||||
Build with experimental Green Tea GC (Go 1.25+):
|
||||
|
||||
```bash
|
||||
make build-experimental
|
||||
task build-experimental
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
Reference in New Issue
Block a user