feat: add some documentation
All checks were successful
Deploy to GitHub Pages / build_site (push) Successful in 2m10s
All checks were successful
Deploy to GitHub Pages / build_site (push) Successful in 2m10s
This commit is contained in:
49
README.md
49
README.md
@@ -1,3 +1,50 @@
|
||||
Nodarium
|
||||
|
||||
Info tbd.
|
||||
<div align="center">
|
||||
|
||||
<a href="https://nodes.max-richter.dev/"><h2 align="center">Nodarium</h2></a>
|
||||
|
||||
<p align="center">
|
||||
Nodarium is a WebAssembly based visual programming language.
|
||||
</p>
|
||||
|
||||
<img src=".github/graphics/nodes.svg" width="50%"/>
|
||||
|
||||
</div>
|
||||
|
||||
# Table of contents
|
||||
|
||||
- [Architecture](./ARCHITECTURE.md)
|
||||
- [Developing](#developing)
|
||||
- [Roadmap](#roadmap)
|
||||
|
||||
# Developing
|
||||
|
||||
### Install prerequisites:
|
||||
|
||||
- [Node.js](https://nodejs.org/en/download)
|
||||
- [pnpm](https://pnpm.io/installation)
|
||||
- [rust](https://www.rust-lang.org/tools/install)
|
||||
|
||||
### Install dependencies
|
||||
|
||||
```bash
|
||||
pnpm i
|
||||
```
|
||||
|
||||
### Build the Nodes
|
||||
|
||||
```bash
|
||||
pnpm build:nodes
|
||||
```
|
||||
|
||||
### Start the dev server
|
||||
|
||||
```bash
|
||||
cd app
|
||||
pnpm dev
|
||||
```
|
||||
|
||||
### [Now you can create your first node 🤓](./DEVELOPING_NODES.md)
|
||||
|
||||
# Roadmap
|
||||
|
||||
Reference in New Issue
Block a user