fix docs and remote isntall script (#63)

Co-authored-by: sandwich <[email protected]>

Author: dskvr

README.md

@@ -80,15 +80,15 @@ You can also specify the location directly:
 ### Other Methods
 
 - **From release**: Download from [releases page](https://github.com/sandwichfarm/hyprlax/releases)
-- **Manual build**: See [installation guide](docs/installation.md)
+- **Manual build**: See [building from source](docs/development/building.md)
 
 ### Dependencies
 
 #### Wayland
 - Wayland, wayland-protocols, Mesa (EGL/GLES)
 
 
-Full dependency list: [installation guide](docs/installation.md#dependencies)
+Full dependency list: [installation guide](docs/getting-started/installation.md#dependencies)
 
 ## Quick Start
 
@@ -111,19 +111,20 @@ HYPRLAX_COMPOSITOR=sway hyprlax ~/Pictures/wallpaper.jpg
 
 ### Key Options
 
-- `-s, --shift` - Pixels to shift per workspace (default: 200)
+- `-s, --shift` - Pixels to shift per workspace (default: 150)
 - `-d, --duration` - Animation duration in seconds (default: 1.0)
 - `-e, --easing` - Animation curve: linear, sine, expo, elastic, etc.
+- `--input` - Parallax inputs (e.g., `workspace,cursor:0.3`)
 - `-p, --platform` - Platform backend: `wayland` or `auto` (default: auto)
 - `-C, --compositor` - Compositor: `hyprland`, `sway`, `generic`, `auto` (default: auto)
-- `--layer` - Add layer: `image:shift:opacity[:easing[:delay[:duration[:blur]]]]`
+- `--layer` - Add layer: `image:shift:opacity[:blur]`
 - `--config` - Load from config file
 
-**Full documentation:** [Configuration Guide](docs/configuration.md)
+**Full documentation:** [Configuration Overview](docs/configuration/README.md)
 
 ### Migrating from legacy .conf
 
-Legacy runtime loading of `.conf` files has been removed. Convert once to TOML, then run with the new path:
+Legacy `.conf` files are deprecated. Convert once to TOML for full feature support and better validation:
 
 ```bash
 # Interactive (prompts):
@@ -132,8 +133,8 @@ hyprlax ctl convert-config ~/.config/hyprlax/parallax.conf ~/.config/hyprlax/hyp
 # Non-interactive:
 hyprlax ctl convert-config ~/.config/hyprlax/parallax.conf ~/.config/hyprlax/hyprlax.toml --yes
 
-# If you start hyprlax with a legacy path, it prints the exact convert command
-hyprlax --non-interactive --config ~/.config/hyprlax/parallax.conf
+# If you start hyprlax with a legacy path, it will warn and print a suggested convert command
+hyprlax --config ~/.config/hyprlax/parallax.conf
 ```
 
 ## Compositor Configuration
@@ -164,7 +165,7 @@ riverctl spawn "pkill hyprlax; hyprlax ~/Pictures/wallpaper.jpg"
 
 
 ### Other Compositors
-See [Compositor Configuration Guide](docs/compositors.md) for specific setup instructions.
+See [Compatibility](docs/getting-started/compatibility.md) for specifics.
 
 ## Runtime Control
 
@@ -211,27 +212,30 @@ hyprlax ctl get animation.duration
 hyprlax ctl status
 ```
 
-**Full guide:** [Dynamic Layer Management](docs/IPC.md)
+**Full guide:** [IPC Overview](docs/guides/ipc-overview.md) and [IPC Commands](docs/reference/ipc-commands.md)
 
 ## Documentation
 
 ### 📚 User Guides
-- [Installation](docs/installation.md) - Detailed installation instructions
-- [Configuration](docs/configuration.md) - All configuration options
-- [Environment Variables](docs/configuration/environment.md) - ENV mapping and precedence
-- [Compositor Support](docs/compositors.md) - Compositor-specific features
-- [Multi-Layer Parallax](docs/multi-layer.md) - Creating depth with layers
-- [Animation](docs/animation.md) - Easing functions and timing
-- [Examples](docs/examples.md) - Ready-to-use configurations
+- [Installation](docs/getting-started/installation.md) - Detailed installation instructions
+- [Configuration](docs/configuration/README.md) - All configuration options
+- [Environment Variables](docs/reference/environment-vars.md) - ENV mapping and precedence
+- [Compatibility](docs/getting-started/compatibility.md) - Compositor-specific features
+- [Multi-Layer Parallax](docs/guides/multi-layer.md) - Creating depth with layers
+- [Animation](docs/guides/animation.md) - Easing functions and timing
+- [Examples](docs/guides/examples.md) - Ready-to-run scenes
+
+- [Performance](docs/guides/performance.md) - Optimization tips
+- [Troubleshooting](docs/guides/troubleshooting.md) - Common issues and solutions
 
 ### 🔧 Developer Guides
-- [Architecture](docs/architecture.md) - Modular design and components
-- [Development](docs/development.md) - Building and contributing
-- [Adding Compositors](docs/development.md#adding-compositor-support) - Extending compositor support
+- [Architecture](docs/development/architecture.md) - Modular design and components
+- [Development](docs/development/README.md) - Building and contributing
+- [Adding Compositors](docs/development/architecture.md) - Extending compositor support
 
 ### ❓ Help
-- [Troubleshooting](docs/troubleshooting.md) - Common issues and solutions
-- [Dynamic Layers](docs/IPC.md) - Runtime layer control via IPC
+- [Troubleshooting](docs/guides/troubleshooting.md) - Common issues and solutions
+- [Dynamic Layers](docs/guides/ipc-overview.md) - Runtime layer control via IPC
 
 ## Changelog
 
@@ -247,7 +251,7 @@ hyprlax uses a modular architecture with clear separation of concerns:
 - **Renderer abstraction** - OpenGL ES 2.0 rendering
 - **Core engine** - Animation and configuration management
 
-See [Architecture Documentation](docs/architecture.md) for details.
+See [Architecture Documentation](docs/development/architecture.md) for details.
 
 ### Testing
 
@@ -285,7 +289,7 @@ make lint-fix
 
 Pull requests are welcome! Please read [RELEASE.md](RELEASE.md) for the release process.
 
-See [Development Guide](docs/development.md) for:
+See [Development Guide](docs/development/README.md) for:
 - Building from source
 - Project architecture
 - Adding new features

docs/configuration/examples/basic.toml

@@ -7,7 +7,7 @@ debug = false
 duration = 1.0          # 1 second workspace animation
 shift = 150             # Moderate parallax shift
 vsync = true
-easing = "ease_out"
+easing = "expo"
 
 # Single background image example
 # Uncomment to use just one image:
@@ -27,4 +27,4 @@ blur = 1.0                 # Slight blur for depth
 path = "~/Pictures/foreground.png"
 shift_multiplier = 1.0    # Normal parallax speed
 opacity = 0.95             # Slightly transparent
-blur = 0.0                 # Sharp foreground
+blur = 0.0                 # Sharp foreground

docs/configuration/examples/cursor-parallax.toml

@@ -27,7 +27,6 @@ y = 80
 
 [global.input.cursor]
 follow_global = true
-normalize_to = "monitor"
 sensitivity_x = 0.5
 sensitivity_y = 0.50
 deadzone_px = 3
@@ -53,4 +52,4 @@ scale = 0.70                 # smaller → sits
 align = { x = 0.5, y = -0.2 } 
 shift_multiplier = { x = 1.0, y = 1.0 }
 opacity = 1.0
-blur = 0.0
+blur = 0.0

docs/configuration/legacy-format.md

@@ -55,7 +55,7 @@ Set animation easing function:
 easing expo
 ```
 
-Available: linear, ease, ease_in, ease_out, ease_in_out, expo, cubic, quart, quint, sine, circ, elastic, back, bounce
+Available: linear, cubic, quart, quint, sine, expo, circ, elastic, back, bounce
 
 ### delay
 Set animation delay in seconds:
@@ -137,4 +137,4 @@ For these features, use [TOML configuration](toml-reference.md).
 
 ## Migration to TOML
 
-See the [Migration Guide](migration-guide.md) for converting legacy configs to TOML format.
+See the [Migration Guide](migration-guide.md) for converting legacy configs to TOML format.

docs/configuration/toml-reference.md

@@ -28,19 +28,15 @@ Complete reference for hyprlax TOML configuration format.
 
 ### Easing Functions
 - `linear` - Constant speed
-- `ease` - Smooth start and end
-- `ease_in` - Slow start
-- `ease_out` - Slow end  
-- `ease_in_out` - Slow start and end
-- `expo` - Exponential (default)
-- `cubic` - Cubic curve
-- `quart` - Quartic curve
-- `quint` - Quintic curve
-- `sine` - Sinusoidal
-- `circ` - Circular
-- `elastic` - Elastic bounce
-- `back` - Overshoot and return
-- `bounce` - Bounce effect
+- `cubic` - Cubic ease-out (default)
+- `quart` - Quartic ease-out
+- `quint` - Quintic ease-out
+- `sine` - Sinusoidal ease-out
+- `expo` - Exponential ease-out
+- `circ` - Circular ease-out
+- `elastic` - Elastic overshoot
+- `back` - Slight pull-back before moving
+- `bounce` - Bouncing settle
 
 ## Parallax Settings
 
@@ -165,13 +161,12 @@ y = 150
 
 [global.input.cursor]
 follow_global = true
-normalize_to = "monitor"
 sensitivity_x = 1.2
 sensitivity_y = 0.8
 deadzone_px = 5
 ema_alpha = 0.3        # Smooth cursor movement
 animation_duration = 2.0
-easing = "ease_out"
+easing = "expo"
 
 # Background layer - moves slowly
 [[global.layers]]

docs/development/README.md

@@ -31,7 +31,7 @@ make debug
 make test
 
 # Format code
-make format
+# Use your editor/clang-format. No built-in 'make format' target.
 
 # Commit changes
 git add -A
@@ -105,7 +105,7 @@ make check
 make test
 
 # Coverage report
-make coverage
+# Not provided by Makefile; use external tools if needed.
 ```
 
 ## Contributing Guidelines
@@ -159,10 +159,7 @@ See [Testing](testing.md) for test writing guide.
 ## Documentation
 
 ### Building Docs
-```bash
-# Generate from source
-make docs
-```
+No dedicated docs build target is provided. Edit files under `docs/` directly.
 
 ### Documentation Style
 - Clear, concise language
@@ -173,9 +170,9 @@ make docs
 ## Release Process
 
 ### Version Bumping
-1. Update version in `src/version.h`
+1. Update `VERSION` file if needed (build embeds it as HYPRLAX_VERSION)
 2. Update CHANGELOG.md
-3. Tag release: `git tag -a v2.0.0 -m "Release v2.0.0"`
+3. Tag release: `git tag -a vX.Y.Z -m "Release vX.Y.Z"`
 
 ### Building Release
 ```bash
@@ -210,4 +207,4 @@ echo $XDG_SESSION_TYPE
 
 # Debug output
 ./hyprlax --debug test.jpg 2>&1 | head -100
-```
+```

docs/development/building.md

@@ -170,8 +170,8 @@ sudo make install
 ```
 Default locations:
 - Binary: `/usr/local/bin/hyprlax`
-- Docs: `/usr/local/share/doc/hyprlax/`
-- Examples: `/usr/local/share/hyprlax/examples/`
+- Docs: `/usr/local/share/doc/hyprlax/` (if packaged externally)
+- Examples: Included in the repository under `examples/` (not installed by default)
 
 ### Custom Prefix
 ```bash

docs/development/testing.md

@@ -333,11 +333,7 @@ jobs:
     - name: Memory check
       run: make memcheck
 
-    - name: Coverage
-      run: make coverage
-    
-    - name: Upload coverage
-      uses: codecov/codecov-action@v2
+    # Coverage not provided by Makefile; integrate external tooling if desired
 ```
 
 ## Test Checklist

docs/guides/animation.md

@@ -7,9 +7,7 @@ Master the animation system to create smooth, natural parallax effects.
 Hyprlax combines one or more **input sources** to drive layer movement:
 - `workspace`: driven by workspace changes (original behavior)
 - `cursor`: driven by smoothed cursor motion
-- `window` *(planned)*: will track the active window position
-
-> The `window` source is currently implemented for Hyprland. Other compositors ignore it gracefully until native support is added.
+- `window`: tracks the active window center (implemented for Hyprland; other compositors ignore it gracefully until native support is added)
 
 Configure sources via CLI or TOML:
 

docs/guides/cursor-tracking.md

@@ -96,12 +96,12 @@ Animate cursor-driven changes:
 ```toml
 [global.input.cursor]
 animation_duration = 3.0    # Seconds to animate position changes
-easing = "ease_out"         # Easing function for cursor animation
+easing = "expo"             # Easing function for cursor animation
 ```
 
 ## Normalization
 
-Note: Cursor normalization targets are currently fixed; configuration of `normalize_to` is not supported.
+Note: Cursor normalization targets are currently fixed; `normalize_to` is reserved and not configurable in this build.
 
 ## Movement Control
 
@@ -207,7 +207,6 @@ y = true
 [global.input.cursor]
 sensitivity_x = 0.5
 sensitivity_y = 0.5
-normalize_to = "monitor"
 
 [[global.layers]]
 path = "card_shadow.png"
@@ -250,7 +249,6 @@ Use canvas normalization for uniform behavior:
 
 ```toml
 [global.input.cursor]
-normalize_to = "canvas"
 follow_global = true
 ```
 
@@ -322,13 +320,12 @@ y = 200
 
 [global.input.cursor]
 follow_global = true
-normalize_to = "monitor"
 sensitivity_x = 1.0
 sensitivity_y = 0.7
 deadzone_px = 2
 ema_alpha = 0.25
 animation_duration = 2.5
-easing = "ease_out"
+easing = "expo"
 
 # Sky - barely moves
 [[global.layers]]