diff --git a/.github/workflows/archive.yml b/.github/workflows/archive.yml index 076e58e..65c60c1 100644 --- a/.github/workflows/archive.yml +++ b/.github/workflows/archive.yml @@ -24,12 +24,14 @@ jobs: - name: Create XRNX_Starter_Pack run: | mkdir dist + cp -rf definitions dist/definitions cp -rf book dist/docs cp -rf tools dist/tools - cd dist && zip -r -q ../XRNX_Starter_Pack.zip . + rm -rf dist/*/.git dist/*/.gitignore + echo -e '\n\n\n\n' > dist/docs.html - name: Archive uses: actions/upload-artifact@v4 with: - name: Archive - path: XRNX_Starter_Pack.zip + name: XRNX_Starter_Pack + path: dist diff --git a/.gitignore b/.gitignore index 53631a4..195e70a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,6 @@ Cargo.lock /book/ +/dist/ /generate/Cargo.lock /generate/target/ /generate/lua-language-server/ diff --git a/README.md b/README.md index c4d89e1..68fb13e 100644 --- a/README.md +++ b/README.md @@ -4,20 +4,24 @@ 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/). -### Getting Started +### Documentation & Guides -Read the [Renoise Scripting Development Book](https://renoise.github.io/xrnx) +Read the [Renoise Scripting Development Book](https://renoise.github.io/xrnx). 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. -### Example tools +### Example Tools -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. +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. The example tools are also included in the XRNX Starter pack (see below). -See https://github.com/renoise/tools for tools created by the Renoise team that actually do something. +See [github.com/renoise/tools](https://github.com/renoise/tools) for tools created by the Renoise team that actually do something. + +### Starter Pack + +The scripting development book, API definition and example tools, can also be downloaded as a "starter pack" bundle file from the [releases page](https://github.com/renoise/xrnx/releases). ### Need more help? 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). -*Have fun scripting and hacking Renoise! \ No newline at end of file +*Have fun scripting and hacking Renoise!* \ No newline at end of file diff --git a/tools/README.md b/tools/README.md deleted file mode 100644 index df635b4..0000000 --- a/tools/README.md +++ /dev/null @@ -1 +0,0 @@ -# Examples