Markdownify readme

2 files changed, 56 insertions, 42 deletions

diff --git a/README b/README
index 1cf4845..5b99949 100644
--- a/README
+++ b/README
@@ -1,82 +1,95 @@
 The Facebook protocol plugin for bitlbee. This plugin uses the Facebook
 Mobile API.
 
-Building and Installing:
-  Make sure bitlbee and its headers have been installed. If bitlbee came
-  from the distribution's repository, it will most likely need the
-  development package, usually bitlbee-dev.
+## Building and Installing
 
-  If bitlbee was built by hand (or alike via a script), ensure the make
-  target `install-dev` is invoked. This target is not called by default,
-  and will install the headers that are needed.
+Make sure bitlbee and its headers have been installed. If bitlbee came
+from the distribution's repository, it will most likely need the
+development package, usually bitlbee-dev.
 
-  Do *not* use the source tree headers unless you know what you are
-  doing. This can lead to mismatched header versions, which often times
-  will lead to bad things.
+If bitlbee was built by hand (or alike via a script), ensure the make
+target `install-dev` is invoked. This target is not called by default,
+and will install the headers that are needed.
 
-  $ git clone https://github.com/jgeboski/bitlbee-facebook.git
-  $ cd bitlbee-facebook
+Do *not* use the source tree headers unless you know what you are
+doing. This can lead to mismatched header versions, which often times
+will lead to bad things.
+
+    $ git clone https://github.com/jgeboski/bitlbee-facebook.git
+    $ cd bitlbee-facebook
+
+With a "global" (or system) bitlbee installation:
 
-  With a "global" (or system) bitlbee installation:
     $ ./autogen.sh
     $ make
     $ make install
 
-  Or with a "local" bitlbee installation (location: $HOME/bitlbee):
+Or with a "local" bitlbee installation (location: $HOME/bitlbee):
+
     $ export BITLBEE_CFLAGS="-I$HOME/bitlbee/include/bitlbee"
     $ export BITLBEE_LIBS=""
     $ ./autogen.sh --libdir=$HOME/bitlbee/lib
     $ make
     $ make install
 
-Usage:
-  Before continuing, please note, it is recommended that you use an app
-  password for your Facebook account. Not only is this more secure than
-  leaving your password within bitlbee, but it allows the usage of two
-  factor authentication methods. An app password can be generated via
-  the security page on the Facebook website.
+## Usage
+
+Before continuing, please note, it is recommended that you use an app
+password for your Facebook account. Not only is this more secure than
+leaving your password within bitlbee, but it allows the usage of two
+factor authentication methods. An app password can be generated via
+the security page on the Facebook website.
+
+Getting started:
 
-  Getting started:
     > account add facebook <username> <password>
     > account <acc> on
 
-  Group Chats (existing chat):
+Group Chats (existing chat):
+
     > fbchats [acc]
     > fbjoin [acc] <index> <channel>
     > /topic <message>
     > /invite <user>
 
-  Group Chats (creating chat):
+Group Chats (creating chat):
+
     > fbcreate [acc] <user,user,...>
     > fbjoin [acc] 1 <channel>
     > /topic <message>
     > /invite <user>
 
-Debugging:
-  Before debugging can begin, the plugin must be compiled with debugging
-  support. Once debugging support has been enabled, one of the two
-  supported environment variables can be defined to enable debugging
-  output. This can be used in unison with debuggers such as GDB, which
-  should enable easier tracing of bugs.
+## Debugging
 
-  When posting to the issue tracker, please ensure any sensitive
-  information has been stripped.
+Before debugging can begin, the plugin must be compiled with debugging
+support. Once debugging support has been enabled, one of the two
+supported environment variables can be defined to enable debugging
+output. This can be used in unison with debuggers such as GDB, which
+should enable easier tracing of bugs.
+
+When posting to the issue tracker, please ensure any sensitive
+information has been stripped.
+
+Enable debugging support (modify the build instructions above):
 
-  Enable debugging support (modify the build instructions above):
     $ ./autogen.sh --enable-debug
 
-  Enable debugging output:
-    For bitlbee and the plugin:
-      $ export BITLBEE_DEBUG=1
-      OR
-      $ BITLBEE_DEBUG=1 gdb ...
+Enable debugging output:
+
+For bitlbee and the plugin:
+
+    $ export BITLBEE_DEBUG=1
+    OR
+    $ BITLBEE_DEBUG=1 gdb ...
+
+For just the plugin:
+
+    $ export BITLBEE_DEBUG_FACEBOOK=1
+    OR
+    $ BITLBEE_DEBUG_FACEBOOK=1 gdb ...
 
-    For just the plugin:
-      $ export BITLBEE_DEBUG_FACEBOOK=1
-      OR
-      $ BITLBEE_DEBUG_FACEBOOK=1 gdb ...
+Obtaining a GDB backtrace:
 
-  Obtaining a GDB backtrace:
     $ gdb \
         -ex 'handle SIGPIPE nostop noprint pass' \
         -ex 'break g_log' -ex run -ex bt \
diff --git a/README.md b/README.md
new file mode 120000
index 0000000..100b938
--- /dev/null
+++ b/README.md
@@ -0,0 +1 @@
+README
\ No newline at end of file