Update README.md
This commit is contained in:
25
README.md
25
README.md
@@ -8,18 +8,6 @@ tono is a node-based SPM image processing and analysis tool. The main focus is o
|
|||||||
|
|
||||||
It is heavily inspired by [Gwyddion](https://gwyddion.net/), one of my favorite scientific FOSS programs on the web.
|
It is heavily inspired by [Gwyddion](https://gwyddion.net/), one of my favorite scientific FOSS programs on the web.
|
||||||
|
|
||||||
## Project layout
|
|
||||||
|
|
||||||
```text
|
|
||||||
tono/
|
|
||||||
backend/ Python server, execution engine, nodes
|
|
||||||
frontend/ React/Vite app
|
|
||||||
plugins/ User plugin files (.py)
|
|
||||||
tests/ Python tests
|
|
||||||
docs/ Documentation
|
|
||||||
desktop.py Desktop launcher
|
|
||||||
scripts/ Build scripts (macOS, Linux, Windows)
|
|
||||||
```
|
|
||||||
|
|
||||||
## Quick start
|
## Quick start
|
||||||
Install a local binary from the Releases section, or run locally:
|
Install a local binary from the Releases section, or run locally:
|
||||||
@@ -40,3 +28,16 @@ npm run dev # terminal 2 — Vite dev server, open the URL it prints
|
|||||||
- [Building](docs/building.md) — setup, dev mode, web deployment, and native desktop builds for macOS, Linux, and Windows
|
- [Building](docs/building.md) — setup, dev mode, web deployment, and native desktop builds for macOS, Linux, and Windows
|
||||||
- [Plugins](docs/plugins.md) — writing and uploading custom node plugins
|
- [Plugins](docs/plugins.md) — writing and uploading custom node plugins
|
||||||
- [Testing](docs/testing.md) — running tests and writing new ones
|
- [Testing](docs/testing.md) — running tests and writing new ones
|
||||||
|
|
||||||
|
## Project layout
|
||||||
|
|
||||||
|
```text
|
||||||
|
tono/
|
||||||
|
backend/ Python server, execution engine, nodes
|
||||||
|
frontend/ React/Vite app
|
||||||
|
plugins/ User plugin files (.py)
|
||||||
|
tests/ Python tests
|
||||||
|
docs/ Documentation
|
||||||
|
desktop.py Desktop launcher
|
||||||
|
scripts/ Build scripts (macOS, Linux, Windows)
|
||||||
|
```
|
||||||
|
|||||||
Reference in New Issue
Block a user