Gitignore & README

- Add gitignore for output and binary files
- Convert README to markdown
This commit is contained in:
Sravan Balaji
2020-11-23 18:29:56 -05:00
parent 61bb8b2241
commit c8f5653ecd
2 changed files with 29 additions and 20 deletions

5
.gitignore vendored Normal file
View File

@@ -0,0 +1,5 @@
# DWM Files
*.o
*.orig
dwm
config.h

View File

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