diff --git a/documentation/build_docs.md b/documentation/build_docs.md index d67c4fd..c6426f7 100644 --- a/documentation/build_docs.md +++ b/documentation/build_docs.md @@ -42,7 +42,7 @@ other bits and pieces: - use the small screws to attach pi+screen to the back panel -- attach keypad to the back panel and fasten in with a extra screw if nessicary +- attach keypad to the back panel and fasten in with a extra screw if necessary - put large screws through back panel facing up and use spacers @@ -56,4 +56,4 @@ other bits and pieces: [usb keypad]:https://www.aliexpress.com/item/2-4G-Wireless-Keyboard-USB-Numeric-Keypad-19-Keys-Mini-Digital-Keyboard-Ultra-Slim-Number-Pad/32818206308.html?spm=a2g0s.9042311.0.0.FkRWty [key stickers]: https://docs.google.com/document/d/1vhXv5QTfyUqsZuMdQu1lh2dMfEk5HMNVyp8uhrc-I2w/edit?usp=sharing [etcher]: https://etcher.io -[dotfile] : ./dotfiles/README.md \ No newline at end of file +[dotfile] : /dotfiles/README.md \ No newline at end of file diff --git a/documentation/operate_docs.md b/documentation/operate_docs.md index 7b7b919..84c81ae 100644 --- a/documentation/operate_docs.md +++ b/documentation/operate_docs.md @@ -10,6 +10,8 @@ ## controls +(put picture with controls here...) + the controls on r_e_c_u_r work by mapping `keys` to `actions`. (custom mappings ?) by default most keys map to the same action independent of the state (ie display mode) the r_e_c_u_r is in. The exceptions to this are the control keys: @@ -34,10 +36,14 @@ some keys are empty to leave room for future features. i encourage you to make a ## `PLAYER` display +![player_example][player_example] + this section displays information about what is in the video player : the position from start and end of currently playing video, what [slot] is playing now and what slot is loaded [next] ## `BROWSER` display mode +![browser_example][browser_example] + this is where you can load samples from your usb into the `SAMPLER` - in this mode , the `<` and `>` keys will move the selection up and down @@ -47,14 +53,24 @@ this is where you can load samples from your usb into the `SAMPLER` ## `SAMPLER` display mode +![sampler_example][sampler_example] + this is the main display mode for using r_e_c_u_r. from this view you can see details of all the samples loaded into the sampler. a `bank` contains 10 `slots` labelled `0` - `9`. pressing the corresponding `key` will load the `sample` in this `slot` to start when the current sample finishes. the `slot` of the currently playing sample is highlighted. ## `SETTINGS` display mode +![settings_example][settings_example] + this is where you can configure r_e_c_u_r's settings. - navigate the menu with `<` and `>` keys like about - pressing `■` on a setting will either cycle through it's `options` or run an `action` depending on its type (an `action` setting will always have value `run_action`) +## `MESSAGE DISPLAY` -[display_image]: display_parts.jpg \ No newline at end of file +(put image and info here) + +[display_image]: display_parts.jpg +[browser_example]: browser_example.jpg +[sampler_example]: sampler_example.jpg +[settings_example]: settings_example.jpg \ No newline at end of file diff --git a/documentation/player_example.jpg b/documentation/player_example.jpg new file mode 100644 index 0000000..530fd09 Binary files /dev/null and b/documentation/player_example.jpg differ diff --git a/documentation/sampler_example.jpg b/documentation/sampler_example.jpg index dac7297..bec1a4e 100644 Binary files a/documentation/sampler_example.jpg and b/documentation/sampler_example.jpg differ