Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
emuell committed Aug 2, 2024
1 parent 9b78cc9 commit 576e8dc
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 18 deletions.
22 changes: 22 additions & 0 deletions BUILD.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
## Documentation Development

### Requirements

The docs are generated using [mdBook](https://github.com/rust-lang/mdBook). To preview the pages locally you will need [cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html) to install mdbook and mdbook-linkcheck (which is used to make sure there are no broken links in the book).

```sh
cargo install mdbook
cargo install mdbook-linkcheck
```

### Building

Afterwards you can serve the docs at `localhost:3000` using mdbook, this will automatically refresh the browser tab whenever you change markdown files.

```sh
mdbook serve --open
```

### Generate API reference

See [generate/README.md](./generate/README.md)
29 changes: 11 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,23 @@
<img src="https://www.renoise.com/sites/default/files/renoise_logo_0.png" alt="Renoise" height="100"/>

# Renoise Scripting Docs
## Renoise Scripting Development

This repository contains the documentation for tool scripting in Renoise.
Welcome to the Renoise Lua Scripting Repository! This site is for developers who want to write their own scripts & tools for [Renoise](http://www.renoise.com/). If you are only interested in downloading tools for Renoise and not in developing your own, please have a look at the [Renoise Tools Page](http://tools.renoise.com/).

You can read the docs at [https://renoise.github.io/xrnx](https://renoise.github.io/xrnx) or by browsing the `docs` directory here.
### Getting Started

## Development
Read the [Renoise Scripting Development Book](https://renoise.github.io/xrnx)

### Requirements
This book is highly recommended for anyone who wants to get into all this Renoise scripting. Please read it first to get an overview of what's needed to develop tools for Renoise. It contains an introduction, some guides and the full API documentation.

The docs are generated using [mdBook](https://github.com/rust-lang/mdBook). To preview the pages locally you will need [cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html) to install mdbook and mdbook-linkcheck (which is used to make sure there are no broken links in the book).
### Example tools

```sh
cargo install mdbook
cargo install mdbook-linkcheck
```
In addition to the documentation, this repository also contains some sample tools in the [tools folder](./tools) that are intended for new tool developers only. You can download them, install them, and read them as an interactive tutorial.

### Building
See https://github.com/renoise/tools for tools created by the Renoise team that actually do something.

Afterwards you can serve the docs at `localhost:3000` using mdbook, this will automatically refresh the browser tab whenever you change markdown files.
### Need more help?

```sh
mdbook serve --open
```
For any questions regarding the Lua API or this repository, please have a look at the [Renoise Scripting Development Forum](https://forum.renoise.com/c/renoise-tool-development).

### Generate API reference

See [generate/README.md](./generate/README.md)
*Have fun scripting and hacking Renoise!

0 comments on commit 576e8dc

Please sign in to comment.