From af52850adca9bf737e6e3ef3145949bedbd3e6d8 Mon Sep 17 00:00:00 2001
From: thdaemon <thxdaemon@gmail.com>
Date: Thu, 12 Oct 2017 20:21:45 +0800
Subject: [PATCH] Update README and documents

---
 README.md      | 34 ++++++++++++++++++----------------
 doc/service.md | 26 ++++++++++++++++++++++++++
 2 files changed, 44 insertions(+), 16 deletions(-)
 create mode 100644 doc/service.md

diff --git a/README.md b/README.md
index d033ea6..2254f03 100644
--- a/README.md
+++ b/README.md
@@ -13,17 +13,19 @@ make
 sudo make install
 ```
 
-On FreeBSD, you need use `gmake` instead of `make`. And if you do not want to install gcc, you can use FreeBSD clang compiler
+- On FreeBSD, you need use `gmake` instead of `make`. And if you do not want to install gcc, you can use FreeBSD clang compiler
 
-```
-gmake CC="cc -I/usr/local/include" LDFLAGS="-lX11 -L/usr/local/lib"
-```
+	```
+	gmake CC="cc -I/usr/local/include" LDFLAGS="-lX11 -L/usr/local/lib"
+	```
 
-To build a debug version, you can use
+- To build a debug version, you can use
 
-```
-DEBUG=1 make
-```
+	```
+	DEBUG=1 make
+	```
+
+- `./mkconfig.sh --enable-xsec` can be replaced by `make defconfig` now.
 
 ### Binary Release
 
@@ -60,20 +62,20 @@ Add server options
 You can add the additional options to X server. e.g. -depth x, like this
 
 ```
-# mydm -d :0 -v vt7 -c startxfce4 -u foo -n -- -depth 24
+mydm -d :0 -v vt7 -c startxfce4 -u foo -n -- -depth 24
 ```
 
-For more usages, please run `mydm -h`
-
-### Register mydm to a system service and auto start
+### Register mydm as a system service and auto start
 
-For a init system which supports LSB, you can run it to let mydm to a system service
+For an LSB-supported initialization system, you can register mydm as a system service directly using the following command (as root)
 
 ```
-# mydm-service-install --target linux-lsb --default
+mydm-service-install --target linux-lsb --default
 ```
 
-### XSecurity
+For the specific usage of the mydm-service-install utility, go to [this Wiki](doc/service.md)
+
+### About XSecurity
 
 1. Not Authority
 
@@ -124,4 +126,4 @@ If you do not set it, default X client will be set to 'xterm'
 
 When you compile mydm, libx11-dev may be needed because mydm use some headers of Xlib's. But after compiling mydm, libx11-dev is not needed anymore.
 
-So, if you don't want install to libx11-dev in compiling time, you can see [this Wiki](doc/own-libx11dev.md)
+And if you don't want install to libx11-dev in compiling time, you can see [this Wiki](doc/own-libx11dev.md)
diff --git a/doc/service.md b/doc/service.md
new file mode 100644
index 0000000..0952e08
--- /dev/null
+++ b/doc/service.md
@@ -0,0 +1,26 @@
+## Register mydm as a system service
+
+Making mydm a system service is often useful. Before this feature is developed, if a user want to let mydm boot automatically start, he had to mydm complete start command written in such a file like `/etc/rc.local`
+
+Now, the good news comes, mydm can be installed as a system service. The mydm suite now comes with a script called `mydm-service-install` that allows users to automate installation services on their own systems.
+
+> mydm-service-install now only used in a LSB-supported initialization system. Development of other initialization systems is under way.
+
+```
+mydm-service-install --target linux-lsb --default
+```
+
+install for LSB target, all options are filled in by default
+
+```
+mydm-service-install --target linux-lsb
+```
+
+install for LSB target, the script queries each installation option in an interactive manner, leaving it blank by default.
+
+```
+mydm-service-install --target linux-lsb --uninstall
+```
+
+uninstall for LSB target.
+