Skip to content

Commit

Permalink
✨ added feature links to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lukas-runge committed Aug 28, 2023
1 parent fc6008e commit b2cc57a
Showing 1 changed file with 21 additions and 10 deletions.
31 changes: 21 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,30 @@

A new and intuitive way of controlling intelligent devices developed from first principles for the event industry.

## prerequisites
## 🚀 Contribute

Feel free to check out the concepts here on GitHub, lets discuss your own ideas in [Issues](https://github.com/oshifty/vision/issues) or check out code you want to add via [Pull requests](https://github.com/oshifty/vision/pulls) 🥳

- [Type Documentation](https://oshifty.github.io/vision) → checkout running [locally](http://localhost:8000) (`npm run doc`)
- [WebSocket Demo](/src/routes/webSocketDemo) → checkout w/ running dev server: [/websocketDemo](http://localhost:5173/webSocketDemo)
- [Visualizer](/src/routes/visualizer) → checkout w/ running dev server: [/visualizer](http://localhost:5173/visualizer)
- [Remote](/src/routes/visualizer/remote) → checkout w/ running dev server: [/visualizer/remote](http://localhost:5173/visualizer/remote)

## 🔥 Run locally

### prerequisites

- [**Node.js®**](https://nodejs.org/) LTS

## download
### download

This can either be done thru downloading the repos as [`*.zip`](https://github.com/LightYourWay/grandMA3-ts-template-plugin/archive/refs/heads/master.zip) and unpacking at said path or directly cloning the repository via cmdline.

```bash
git clone https://github.com/oshifty/vision.git <path>
```

## install dependencies
### install dependencies

Open the `<path>` in your IDE

Expand All @@ -28,43 +39,43 @@ and install all dependencies with `npm` in the terminal:
npm install
```

## run app for development
### run app for development

```bash
npm run dev
```

## run tests for development
### run tests for development

```bash
npm run test
```

## build documentation
### build documentation

### for development
#### for development

To build the documentation website for development and watch for file changes to automatically recompile run:

```bash
npm run doc
```

### for production
#### for production

To build your plugin for production run:

```bash
npm run doc:build
```

## lint
### lint

```bash
npm run lint
```

## format
### format

```bash
npm run format
Expand Down

0 comments on commit b2cc57a

Please sign in to comment.