diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index d751ab4..472eca4 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -114,6 +114,7 @@ make -f Makefile.dev release-arch - [x] Clone "shaders" and config in system path at setup - [ ] Minimal sample shaders - [ ] Hotkey `0` to reset everything + - [x] Printable PDF of default scr/fx - [x] Add NanoKontrol setup file - [x] Find and fix opengl errors 0500 ? - [ ] Bonus diff --git a/README.md b/README.md index a2d72cb..56e6de2 100644 --- a/README.md +++ b/README.md @@ -55,7 +55,7 @@ Here are some pointers if you want to customize your FORGE experience: - [What to do next](#what-to-do-next) - [What is FORGE ?](#what-is-forge-) - [Install](#install) - - [Prerequisites](#prerequisites) + - [Requirements](#requirements) - [From release](#from-release) - [From repository (PKGBUILD)](#from-repository-pkgbuild) - [From repository (dev version)](#from-repository-dev-version) @@ -78,6 +78,8 @@ Here are some pointers if you want to customize your FORGE experience: - [Working with subroutines](#working-with-subroutines) - [Frequently Asked Questions](#frequently-asked-questions) - [Why "steel"?](#why-steel) + - [I couldn't install FORGE on my computer](#i-couldnt-install-forge-on-my-computer) + - [I didn't understand everything about your tutorial](#i-didnt-understand-everything-about-your-tutorial) - [My nanoKontrol2 is acting strange](#my-nanokontrol2-is-acting-strange) - [How do I report a bug?](#how-do-i-report-a-bug) - [Help I got low FPS on my video device](#help-i-got-low-fps-on-my-video-device) @@ -106,7 +108,7 @@ Here's a quick rundown of the process: ## Install -### Prerequisites +### Requirements | library | apt | pacman | | --------- | -------------- | --------------- | @@ -243,12 +245,20 @@ Working with pages and items, you can use the following predefined sources and e | | **D** | Cursor | _Size_ | _Pos X_ | _Pos Y_ | Isometric | _Zoom_ | _Scroll_ | _Rotate_ | | | **E** | (Random source) | --- | --- | --- | (Random effect) | --- | --- | --- | +See the [printable version](./docs/forge_default_mapping.pdf). + ## Making your own FORGE project You want to embrace the "user" in "user-defined"? It's time to make your own project. Starts with copying the [sample](./sample) project and make it your own with the following guide. +Then, writing code you can use the `--hot-reload` to watch your visuals as you design them. + +```shell +forge --project= --hot-reload +``` + ### `forge_project.cfg` Every FORGE project starts with a `forge_project.cfg`. @@ -431,6 +441,17 @@ FORGE is a concept which is intended to be derived onto other forms (like Raspbe FORGE (steel) describe the linux version. +### I couldn't install FORGE on my computer + +Verify you have the correct [requirements](#requirements) installed. + +Then if you continue to have problems, you can [open an issue](https://github.com/klemek/forge-steel/issues). + +### I didn't understand everything about your tutorial + +Please [open an issue](https://github.com/klemek/forge-steel/issues) describing what your having trouble with, +I'll try to anwer and update the README. + ### My nanoKontrol2 is acting strange You may need to change your NanoKontrol2 settings to remove the "toggle" behavior of the buttons and use "external" led control. diff --git a/docs/forge_default_mapping.pdf b/docs/forge_default_mapping.pdf new file mode 100644 index 0000000..654a90d Binary files /dev/null and b/docs/forge_default_mapping.pdf differ