浏览代码

Wrote readme

Fredrik Haikarainen 11 年前
父节点
当前提交
c3f1d26045
共有 1 个文件被更改,包括 49 次插入2 次删除
  1. 49
    2
      README

+ 49
- 2
README 查看文件

@@ -1,3 +1,50 @@
1
-light
1
+Light 0.4
2
+---------
2 3
 
3
-Program to control backlight-controllers in linux system.
4
+ - Description ---
5
+
6
+"Light" is a program to control backlight-controllers in GNU/Linux-systems. It is the successor of "LightScript",
7
+which is a bash-script with the same purpose, and tries to maintain the same functionality.
8
+
9
+It features:
10
+
11
+	* Works excellent where other software has proven unusable/problematic(xbacklight etc) thanks to how
12
+	  it operates internally.
13
+
14
+	* Automatically figures out the best controller to use depending on its resolution, making full use
15
+	  of the underlying hardware. 
16
+
17
+	* Written in ANSI C89 - which practically makes it as portable as a program can be, with the exception
18
+	  of the glibc-dependency.
19
+
20
+
21
+ - Usage ---
22
+
23
+Executed without arguments, light prints usage-information that is pretty self-explanatory.
24
+
25
+Examples:
26
+
27
+	Set brightness to 40 percent:
28
+	light 40
29
+
30
+	Increase brightness with 10% and supress output:
31
+	light -aq 10	
32
+
33
+	Print the maximum-brightness of the best controller and exit:
34
+	light -m
35
+
36
+
37
+ - Installation ---
38
+
39
+	1. Install the neccesary buildtools (make, gcc etc)
40
+
41
+	2. Type "make stable"
42
+
43
+	3. Success? Copy/symlink the "light"-executable to /usr/bin.
44
+
45
+	4. Enjoy!
46
+
47
+
48
+ - Contact ---
49
+
50
+In case of any feedback(problems/bugs, feature-requests etc) contact me directly on fredrik.haikarainen@gmail.com