# Installation Guide This guide will walk you through installing Riceify on your Linux system. ## Riceify ### 🚀 Quick Install The fastest way to get Riceify running on your system. ```bash curl -sSL https://raw.githubusercontent.com/MadeInLithuania/Riceify/main/install.sh | bash ``` ### Package (soon) ### Manual build (source) ```bash git clone https://github.com/MadeInLithuania/Riceify cd Riceify mkdir build && cd build cmake .. make -j$(nproc) sudo make install ``` ### What the Quick Install Does 1. **Downloads** the latest release 2. **Extracts** the binary to `/usr/local/bin/` 3. **Sets up** basic configuration 4. **Creates** necessary directories 5. **Installs** man pages and documentation ### Verification After installation, verify Riceify is working: ```bash riceify --version riceify --help ``` ## 🔧 Install from Source For users who want the latest features or need to customize the build. ### Step 1: Clone the Repository ```bash git clone https://github.com/MadeInLithuania/Riceify.git cd Riceify ``` ### Step 2: Install Dependencies #### Ubuntu/Debian ```bash sudo apt update sudo apt install build-essential cmake git libboost-all-dev libssl-dev zlib1g-dev libcurl4-openssl-dev ``` #### Fedora ```bash sudo dnf install gcc-c++ cmake git boost-devel openssl-devel zlib-devel libcurl-devel ``` #### Arch Linux ```bash sudo pacman -S base-devel cmake git boost openssl zlib curl ``` #### macOS ```bash brew install cmake boost openssl zlib curl ``` ### Step 3: Build and Install ```bash #### Create build directory mkdir build && cd build #### Configure with CMake cmake .. #### Build (use all available cores) make -j$(nproc) #### Install (requires sudo) sudo make install ``` ### Step 4: Verify Installation ```bash riceify --version riceify --help ``` ## ⚡ Performance Build For maximum performance and optimization. ### Automated Performance Build ```bash ### Make build script executable chmod +x build.sh ### Run performance build ./build.sh ``` ### What Performance Build Creates - **Release Build**: Optimized for production use - **Maximum Optimization**: Highest performance settings - **Profile-Guided Optimization**: Uses runtime profiling - **Link Time Optimization**: Whole-program optimization ### Manual Performance Build ```bash mkdir build && cd build ### Configure with performance options cmake -DCMAKE_BUILD_TYPE=Release \ -DCMAKE_CXX_FLAGS="-O3 -march=native -mtune=native" \ -DENABLE_LTO=ON \ -DENABLE_PGO=ON \ .. ### Build with all optimizations make -j$(nproc) ### Install sudo make install ``` ## 📦 Package Manager Installation SOON ## Polybar integration SOON