Merge pull request #3 from legomir/dev

Update docs

README.md

@@ -4,24 +4,39 @@
 Rampage is utility for __Sidefx Houdini__ meant to help with managing user made presets for ramp
 parameters. Houdini have some build in preset for ramps:
 ![Default ramp preset](/docs/images/build_in_ramp_presets.png)
-However editing this list by user is quite hard. Menu can be edited by adding package/user directory file called __File name here__. Those files have quite abstract syntax and any to see changed restart of Houdini is required. The goal of __Rampage__ is to simplify this process by providing simple way of creating and managing preset for ramp parameters.
+However editing this list by user is quite hard. Menu can be edited by adding package/user directory one file called __float.ramp__ or __color.ramp__. Those files have syntax similar to json but to see any changes restart of Houdini is required. The goal of __Rampage__ is to simplify this process by providing simple way of creating and managing preset for ramp parameters.
 
 Both __color__ and __float__ ramps are supported.
 
 ## Rampage menu:
 All functionality can be found in rampage menu:
+
 ![Rampage menu](/docs/images/rampage_menu.png)
 ### Add preset to rampage:
 Simply ask for name of presets and let choose name. Name have to be unique!
+
 ![Rampage add preset menu](/docs/images/rampge_add_preset_menu.png)
 ### Replace rampage preset:
 Shows list of existing presets and let choose which one should be replaced:
+
 ![Rampage replace preset menu](docs/images/rampage_replace_preset_menu.png)
 ### Remove rampage preset:
 Show list of existing presets and let choose which one should be removed:
+
 ![Rampage remove preset menu](docs/images/rampage_remove_preset_menu.png)
 ### Presets submenu:
 Let you choose from list of existing presets for given type of ramp.
+
 ![Rampage presets submenu](docs/images/presets_submenu.png)
+## Implementations details:
+### Package file
+__Rampage__ is implemented with [Houdini packages](https://www.sidefx.com/docs/houdini/ref/plugins.html) in mind. That allow ease of installation and defining variables.
+Variables defined by __Rampage__:
+- _$RAMPAGE_PATH_ : path to rampage directory
+- _$RAMPAGE_PRESETS_PATH_ : path to directory that contains presets
+### Preset files
+Presets are stored in _%RAMPAGE_PRESETS_PATH_ as json files. __color.json__ for color ramp and __float.json__ for float ramp. Currently there is no way to concatenate preset files in multiple locations.
 ## Requirements
-__Houdini__ - __Python 3__ version(most of functions is typed)
+__Houdini__ - __Python 3__ version(most of functions is typed)
+## Contributors
+- Paweł Bernaciak

package_example/rampage.json

@@ -0,0 +1,13 @@
+{
+    "path": "$RAMPAGE_PATH",
+    "load_package_once": true,
+    "version": "1.0.0",
+    "env": [
+        {
+            "RAMPAGE_PATH": "$HOME/dev/houdini_packages/rampage"
+        },
+        {
+            "RAMPAGE_PRESETS_PATH": "$RAMPAGE_PATH/presets/"
+        }
+    ]
+}