commit 291787ac0b93c3f1952d42bb3da065e4b98cb65b
parent 7c315b7dd2c51b9c7beb0ce2bcfe908007822a84
Author: nyangkosense <sebastian.michalk@protonmail.com>
Date: Mon, 14 Oct 2024 15:13:14 +0000
readme
Diffstat:
| M | README.md | | | 85 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++-- |
1 file changed, 83 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
@@ -1,2 +1,83 @@
-# nyxwm
-Nyx Window Manager
+# nyxwm - Nyx Window Manager
+
+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.
+
+## Features
+
+- Minimalist design philosophy
+- Low resource usage
+- Customizable statusbar with real-time updates
+- Simple window management with keyboard shortcuts
+- Support for multiple workspaces
+- Customizable through config.h
+- Integrated systray
+- Autostart script support
+
+## Dependencies
+
+To build and run nyxwm, you'll need the following:
+
+- Xlib header files
+- libXft
+- libX11
+- make
+- A C compiler (gcc or clang)
+
+## Installation
+
+1. Clone the repository:
+ ```
+ git clone https://github.com/yourusername/nyxwm.git
+ cd nyxwm
+ ```
+
+2. Edit config.h to your liking.
+
+3. Build and install:
+ ```
+ make
+ sudo make install
+ ```
+
+## Configuration
+
+nyxwm is configured through the `config.h` file. You can modify keybindings, colors, and other settings here.
+
+The status bar can be customized by editing the `blocks.h` file, where you can add or remove status elements.
+
+## Usage
+
+Add the following line to your `.xinitrc` file:
+
+```
+exec nyxwm
+```
+
+Then, you can start nyxwm by running `startx`.
+
+### Default Keybindings
+
+- `Mod4 + Enter`: Open terminal (st)
+- `Mod4 + p`: Open dmenu
+- `Mod4 + [1-9]`: Switch to workspace
+- `Mod4 + Shift + [1-9]`: Move window to workspace
+- `Mod4 + f`: Toggle fullscreen
+- `Mod4 + q`: Close window
+
+(Add more keybindings as per your configuration)
+
+## Autostart
+
+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.
+
+## Contributing
+
+Contributions to nyxwm are welcome! Please feel free to submit pull requests or open issues for bugs and feature requests.
+
+## Acknowledgments
+
+nyxwm is forked from [sowm](https://github.com/dylanaraps/sowm) by Dylan Araps and incorporates ideas from [dwmblocks](https://github.com/torrinfail/dwmblocks).
+
+## License
+
+nyxwm is distributed under the MIT License. See `LICENSE` file for more information.
