diff options
authorPřemysl Janouch <p.janouch@gmail.com>2015-09-27 01:48:07 +0200
committerPřemysl Janouch <p.janouch@gmail.com>2015-09-27 01:48:07 +0200
commit7696d0fa923b54856c2cdc8da6e2daffab174089 (patch)
parentf7b5641ee2a20a4d1473db47e7ad29b021d57217 (diff)
Convert README to AsciiDoc
-rw-r--r--README.adoc (renamed from README)13
1 files changed, 7 insertions, 6 deletions
diff --git a/README b/README.adoc
index d821f34..ee18b70 100644
--- a/README
+++ b/README.adoc
@@ -9,11 +9,11 @@ Make sure to let the Windows Razer Synapse tool upgrade the firmware to the
newest version before running the program. There might be some issues otherwise
due to protocol changes, although I don't really deem it very probable.
-Run `razer-bw-te-ctl --help' or `man razer-bw-te-ctl' for usage information.
+Run `razer-bw-te-ctl --help` or `man razer-bw-te-ctl` for usage information.
-Build dependencies: cmake >= 2.8.5, help2man
+Build dependencies: cmake >= 2.8.5, help2man +
Runtime dependencies: libusb >= 1.0
$ git clone git://github.com/pjanouch/razer-bw-te-ctl.git
@@ -22,14 +22,15 @@ Runtime dependencies: libusb >= 1.0
$ cmake .. -DCMAKE_INSTALL_PREFIX=/usr
# make install
-Note that there's no "make uninstall".
+Note that there's no `make uninstall`.
For Debian-based distros, you can do the following instead of the last step:
$ cpack -G DEB
# dpkg -i razer-bw-te-ctl-*.deb
-Note that for versions of CMake before 2.8.9, you need to prefix cpack with
-`fakeroot' or file ownership will end up wrong.
+Note that for versions of CMake before 2.8.9, you need to prefix `cpack` with
+`fakeroot` or file ownership will end up wrong.
Contributing and Support
@@ -39,7 +40,7 @@ the developer, feel free to join me at irc://anathema.irc.so, channel #anathema.
-`razer-bw-te-ctl' is written by Přemysl Janouch <p.janouch@gmail.com>.
+'razer-bw-te-ctl' is written by Přemysl Janouch <p.janouch@gmail.com>.
You may use the software under the terms of the ISC license, the text of which
is included within the package, or, at your option, you may relicense the work