[doc] Update the readme

This commit is contained in:
Anas Elgarhy 2023-05-11 02:06:09 +03:00
parent 75ec761539
commit 0a99c90162
No known key found for this signature in database
GPG Key ID: 0501802A1D496528
2 changed files with 6 additions and 94 deletions

48
README
View File

@ -1,48 +0,0 @@
dwm - dynamic window manager
============================
dwm is an extremely fast, small, and dynamic window manager for X.
Requirements
------------
In order to build dwm you need the Xlib header files.
Installation
------------
Edit config.mk to match your local setup (dwm is installed into
the /usr/local namespace by default).
Afterwards enter the following command to build and install dwm (if
necessary as root):
make clean install
Running dwm
-----------
Add the following line to your .xinitrc to start dwm using startx:
exec dwm
In order to connect dwm to a specific display, make sure that
the DISPLAY environment variable is set correctly, e.g.:
DISPLAY=foo.bar:1 exec dwm
(This will start dwm on display :1 of the host foo.bar.)
In order to display status info in the bar, you can do something
like this in your .xinitrc:
while xsetroot -name "`date` `uptime | sed 's/.*,//'`"
do
sleep 1
done &
exec dwm
Configuration
-------------
The configuration of dwm is done by creating a custom config.h
and (re)compiling the source code.

View File

@ -1,5 +1,5 @@
# Anas Elgarhy's dwm
## My fork from dwm 🍴, with a lot of beautiful patches 🥰
# yo-dwm
## DWM but cleaner and more usable
### Applayed patches:
- [alwayscenter](https://dwm.suckless.org/patches/alwayscenter)
@ -15,52 +15,12 @@
- [centeredmaster](https://dwm.suckless.org/patches/centeredmaster)
- [keychain](https://dwm.suckless.org/patches/keychain)
### Dependencies (apps)
- `google-chrome-stable` the main web browser
- `alacritty` the main terminal
- `spectacle` the main screenshot tool
- `pcmanfm` the GUI file manger
- `rofi`
- `dmenu`
- `libxinerama-dev`\*\*
- `tmux`\*
- `tor-browser`
- `discord`
### Dependencies
- `libxinerama-dev`
- `libxft-bgra` for color emojies support
- `jetbrains-toolbox`
- `nvim`\*
- `vim`\*
- `xbacklight` for control in the screen brightness
- `pamixer` for control in the audio level
- `playerctl` for control in the media
- `pactl` for control in the mic
- `betterlockscreen` for lock screen
- `setxkbmap` for switch between keyboard layouts, like (ar, en)
- `slstatus` the status bar
- `network-manager-applet`
- `picom` compositor , for transparency
- `nitrogen` for set the wallpaper
- `copyq` clipboard manager
- `obsidian`
> \*\*: build dependencie.
### Install
- Manual:
1. Run this command to install all avilable dependencies in standerd arch repostory
```bash
sudo pacman -S google-chrome libxft-bgra rofi dmenu tmux tor-browser discord neovim jetbrains-toolbox vim pamixer playerctl betterlockscreen pcmanfm spectacle alacritty picom nitrogen libxinerama network-manager-applet copyq obsidian
```
2. Install yay if you not installed it.
3. Run this command to install all avilable dependencies in the AUR repostory `yay -S xkblayout`
4. Clone this repostory `git clone https://github.com/anas-elgarhy/dwm-anas.git`
5. Go to the source directory `cd dwm-anas/src`
6. Build and install `sudo make install clean`
7. Enjoy 😉
### Available in
- `yo-slstatus` the status bar
### Available in
[![GitHub](https://img.shields.io/badge/GitHub-Main%20repo-brightgreen?style=for-the-badge&logo=GitHub)](https://github.com/anas-elgarhy/dwm-anas)
[![GitLab](https://img.shields.io/badge/GitLab-Mirror%20repo-brightgreen?style=for-the-badge&logo=GitLab)](https://gitlab.com/anas-elgarhy/dwm-anas)
[![BitBucket](https://img.shields.io/badge/BitBucket-Mirror%20repo-brightgreen?style=for-the-badge&logo=BitBucket)](https://bitbucket.org/anas_elgarhy/dwm-anas)