Browse Source

Move README to markdown

Remi Reuvekamp 2 years ago
parent
commit
a083f23608
1 changed files with 31 additions and 22 deletions
  1. 31
    22
      panel/README.md

panel/README → panel/README.md View File

@@ -1,8 +1,12 @@
1
+# panel
2
+
1 3
 Panel which shows the status of workspaces in the BSPWM.
2
-Every workspace has it's own block with the colour depending on the workspace state.
4
+Every workspace has its own block with the colour depending on the workspace state.
5
+
6
+## Usage
3 7
 
4
-Usage:
5
-	$ panel --help
8
+$ panel --help
9
+```
6 10
 		-align int
7 11
 			0, 1, 2 for left, center, right respectively. Can only be used with force-width and force-item-width
8 12
 
@@ -47,6 +51,7 @@ Usage:
47 51
 			colour of spacer between workspace blocks (default "#000000")
48 52
 		-spacer-width int
49 53
 			width of spacer between workspace blocks (default 5)
54
+```
50 55
 
51 56
 Note: Only one of these can be used at a time, since they conflict.
52 57
 	force-item-width
@@ -54,27 +59,31 @@ Note: Only one of these can be used at a time, since they conflict.
54 59
 
55 60
 Note: When using force-item-width or force-width, margin-left and margin-rigth cannot be used.
56 61
 
57
-Examples:
58
-	$ panel
59
-	SCREENSHOT
62
+## Examples
63
+
64
+$ panel
65
+SCREENSHOT
66
+
67
+$ panel -force-item-width 30 -height 10 -align 1 -margin-vertical 10
68
+SCREENSHOT
69
+
70
+$ panel -margin-left 100 -margin-right 100
71
+You would use this if you have got other panels at the left and right, in this example both 100 pixels, and don't want them to overlap with this panel.
72
+SCREENSHOT
60 73
 
61
-	$ panel -force-item-width 30 -height 10 -align 1 -margin-vertical 10
62
-	SCREENSHOT
74
+## Dependencies
63 75
 
64
-	$ panel -margin-left 100 -margin-right 100
65
-	You would use this if you have got other panels at the left and right, in this example both 100 pixels, and don't want them to overlap with this panel.
66
-	SCREENSHOT
76
+dzen2
77
+bspc / bspwm
78
+xrandr
79
+go compiler (If you'd like I could build a binary for you. Contact me by using the author information of the Git commits.)
67 80
 
68
-Dependencies:
69
-	dzen2
70
-	bspc / bspwm
71
-	xrandr
72
-	go compiler
73
-		If you'd like I could build a binary for you. Contact me by the contact information in the README in the root of the repository.
81
+## TODO
74 82
 
75
-TODO
76
-	Test multiple monitors. Ignore monitors with only workspaces that contain 'Desktop' in their name.
77
-	Make screenshots for examples.
83
+Test multiple monitors. Ignore monitors with only workspaces that contain 'Desktop' in their name.
84
+Make screenshots for examples.
78 85
 
79
-Future plans
80
-	The force-width and force-item-width is a bit of a mess from a user point of view. Maybe have a generic panel-width that is default to 100%.
86
+### Future plans
87
+The force-width and force-item-width is a bit complicated from a user point of view.
88
+Especially because margin cannot be used with it.
89
+Maybe have a generic panel-width that is default to 100%.

Loading…
Cancel
Save