nyxwm

Unnamed repository; edit this file 'description' to name the repository.
Log | Files | Refs | README | LICENSE

README.md (2115B)

      1 # nyxwm - Nyx Window Manager
      2 
      3 nyxwm is a simple, lightweight X window manager forked from [sowm](https://github.com/dylanaraps/sowm) and incorporating features from [dwmblocks](https://github.com/torrinfail/dwmblocks). It aims to provide a minimalist yet functional desktop environment for Linux systems.
      4 
      5 ![rice](https://github.com/user-attachments/assets/a55adf8c-6a01-4a43-9849-a250923ecdad)
      6 
      7 ## Features
      8 
      9 - Floating/fullscreen only, no tiling 
     10 - Minimalist design philosophy
     11 - Low resource usage
     12 - Customizable statusbar with real-time updates
     13 - Simple window management with keyboard shortcuts
     14 - Support for multiple workspaces
     15 - Integrated systray
     16 - Autostart script support
     17 
     18 ## Dependencies
     19 
     20 To build and run nyxwm, you'll need the following:
     21 
     22 - Xlib header files
     23 - libXft
     24 - libX11
     25 - make
     26 - gcc
     27 
     28 ## Installation
     29 
     30 1. Clone the repository:
     31    ```
     32    git clone https://github.com/nyangkosense/nyxwm.git
     33    cd nyxwm
     34    ```
     35 
     36 2. Edit config.h / blocks.h
     37 
     38 3. Build and install:
     39    ```
     40    make
     41    sudo make install
     42    ```
     43 
     44 ## Configuration
     45 
     46 nyxwm is configured through the `config.h` file. You can modify keybindings, colors, and other settings here.
     47 
     48 The status bar can be customized by editing the `blocks.h` file, where you can add or remove status elements.
     49 
     50 ### Default Keybindings
     51 
     52 - `Mod4 + Enter`: Open terminal (st)
     53 - `Mod4 + d`: Open dmenu
     54 - `Mod4 + [1-9]`: Switch to workspace
     55 - `Mod4 + Shift + [1-9]`: Move window to workspace
     56 - `Mod4 + f`: Toggle fullscreen
     57 - `Mod4 + q`: Close window
     58 
     59 (Add more keybindings as per your configuration)
     60 
     61 ## Autostart
     62 
     63 nyxwm looks for an autostart script at `~/.config/nyxwm/autostart.sh`. You can use this to launch programs or set up your environment when nyxwm starts.
     64 
     65 ## Contributing
     66 
     67 Please feel free to submit pull requests or open issues for bugs and feature requests.
     68 
     69 ## Acknowledgments
     70 
     71 nyxwm is forked from [sowm](https://github.com/dylanaraps/sowm) by Dylan Araps 
     72 and incorporates ideas from [dwmblocks](https://github.com/torrinfail/dwmblocks) by torrinfail.
     73 
     74 ## License
     75 
     76 nyxwm is distributed under the MIT License. See `LICENSE` file for more information.