Initial commit

README.md

@@ -0,0 +1,81 @@
+# Azeron Cyborg Linux Configuration Software
+
+Linux configuration software for the Azeron Cyborg gaming keypad (USB ID: 16d0:113c).
+
+## Overview
+
+The Azeron Cyborg keypad works on Linux as a standard HID device, but lacks configuration software for remapping buttons, adjusting analog stick settings, and managing profiles. This project provides both command-line and GUI tools to configure your Azeron device on Linux.
+
+## Features
+
+- **Button Remapping**: Assign keyboard keys, mouse buttons, and macros to any button
+- **Analog Stick Configuration**: Adjust deadzones, sensitivity, and response curves
+- **Profile Management**: Create, save, and switch between multiple configuration profiles
+- **Cross-Platform**: Works on any Linux distribution
+- **No Root Required**: Proper udev rules for user-level access
+
+## Project Structure
+
+- `libazeron/` - Core library for device communication
+- `azeron-cli/` - Command-line configuration tool
+- `azeron-gui/` - Graphical user interface (coming soon)
+- `docs/` - Documentation and user guides
+- `scripts/` - Helper scripts and udev rules
+
+## Quick Start
+
+### Prerequisites
+
+- Linux with libusb-1.0 installed
+- For Fedora: `sudo dnf install libusb1-devel json-c-devel`
+- For Ubuntu/Debian: `sudo apt-get install libusb-1.0-0-dev libjson-c-dev`
+
+### Building from Source
+
+```bash
+git clone <repository-url>
+cd azeron-linux
+mkdir build && cd build
+cmake ..
+make
+sudo make install
+```
+
+### Using the Command-Line Tool
+
+```bash
+# List connected Azeron devices
+sudo azeron-cli list
+
+# Show current button mappings
+sudo azeron-cli show-mappings
+
+# Remap a button (e.g., button 5 to 'W' key)
+sudo azeron-cli map-button 5 KEY_W
+
+# Save current configuration to a profile
+sudo azeron-cli save-profile my_gaming_profile
+```
+
+### Setting up udev Rules
+
+To use the tools without sudo, install the udev rules:
+
+```bash
+sudo cp scripts/udev-rules/99-azeron.rules /etc/udev/rules.d/
+sudo udevadm control --reload-rules
+sudo udevadm trigger
+```
+
+## Development
+
+See [docs/development.md](docs/development.md) for development setup and contribution guidelines.
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.
+
+## Acknowledgments
+
+- Azeron LTD for creating the Cyborg keypad
+- The Linux gaming community for testing and feedback