Skip to content

Commit

Permalink
readme/etc
Browse files Browse the repository at this point in the history
  • Loading branch information
tehn committed Sep 21, 2021
1 parent c1f435b commit 92909ea
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 168 deletions.
160 changes: 0 additions & 160 deletions readme-script.md

This file was deleted.

5 changes: 3 additions & 2 deletions readme-update.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,5 +58,6 @@ tar czvf nornsYYMMDD.tgz YYMMDD.*

## delivery

presently update files are copied to `~/update` from USB disk by `SYSTEM > UPDATE`. in the future a drag-drop from
maiden would be user-friendly.
presently update files are copied to `~/update` via the `SYSTEM > UPDATE` menu, which checks the remote github release against the current version.

it's possible to manually install an update by copying the update file to `~/update`, extracting it, and running `update.sh` directly.
20 changes: 14 additions & 6 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
# norns

general documentation is in [github.com/monome/docs](https://github.com/monome/docs).
- general usage documentation: [monome.org/docs/norns](https://monome.org/docs/norns).
- API docs: [monome.org/docs/norns/api](https://monome.org/docs/norns/api).
- build, install, configuration, and execution: [readme-setup.md](readme-setup.md)
- community discussion and help: [llllllll.co](https://llllllll.co)

Lua api docs are hosted on [monome.org/docs/norns/api](https://monome.org/docs/norns/api).
norns is primarily intended to run on a pi-based sound computer designed by [monome](https://monome.org/norns), which has some supporting repositories:

see [readme-setup.md](readme-setup.md) for build, install, configuration, and execution.
- raspbian-based disk image: [github.com/monome/norns-image](https://github.com/monome/norns-image)
- modified linux kernel: [github.com/monome/linux/](https://github.com/monome/linux/)
- shield, the DIY open-source hardware variant: [github.com/monome/norns-shield](https://github.com/monome/norns-shield)

see [readme-script.md](readme-script.md) for scripting.

check [known bugs](https://github.com/monome/norns/wiki/known-bugs) for any current strange behavior.

---

Expand All @@ -20,3 +22,9 @@ git submodule update --init --recursive
./waf configure
./waf
```

---

`matron` (control system) and `crone` (audio system) were created by @catfact. `maiden` (editor) was created by @ngwese. Each grew with contributions from @artfwo, @jah, @simon, @rv, @pq, @markwheeler, @csboling and many others.

norns was initiated by @tehn (monome).

0 comments on commit 92909ea

Please sign in to comment.