]> granicus.if.org Git - transmission/commitdiff
Fix readme formatting to use proper markdown
authorMike Gelfand <mikedld@mikedld.com>
Thu, 1 Sep 2016 22:07:32 +0000 (01:07 +0300)
committerMike Gelfand <mikedld@mikedld.com>
Thu, 1 Sep 2016 22:07:32 +0000 (01:07 +0300)
README.md

index 395136fb34fabd88965932784b6d70c7e49c5d15..74aef0862792559aacacf7918f4f17acb4a753e4 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,24 +1,20 @@
-ABOUT
+## About
 
-  Transmission is a fast, easy, and free BitTorrent client.
-  It comes in several flavors:
+Transmission is a fast, easy, and free BitTorrent client. It comes in several flavors:
+  * A native Mac OS X GUI application
+  * GTK+ and Qt GUI applications for Linux, BSD, etc.
+  * A headless daemon for servers and routers
+  * A web UI for remote controlling any of the above
 
-    * A native Mac OS X GUI application
-    * GTK+ and Qt GUI applications for Linux, BSD, etc.
-    * A headless daemon for servers and routers
-    * A web UI for remote controlling any of the above
+Visit http://www.transmissionbt.com/ for more information.
 
-  Visit http://www.transmissionbt.com/ for more information.
+## Building
 
-BUILDING
+Transmission has an Xcode project file (Transmission.xcodeproj) for building in Xcode.
 
-  Transmission has an Xcode project file (Transmission.xcodeproj)
-  for building in Xcode.
+For a more detailed description, and dependencies, visit: http://trac.transmissionbt.com/wiki/
 
-  For a more detailed description, and dependancies, visit:
-  http://trac.transmissionbt.com/wiki/
-
-  Building a Transmission release from the command line:
+### Building a Transmission release from the command line
 
     $ xz -d -c transmission-2.11.tar.xz | tar xf -
     $ cd transmission-2.11
@@ -26,15 +22,13 @@ BUILDING
     $ make
     $ sudo make install
 
-  Building Transmission from the nightly builds:
+### Building Transmission from the nightly builds
 
-    Download a tarball from http://build.transmissionbt.com/job/trunk-linux-inc/
-    and follow the steps from the previous section.
+Download a tarball from http://build.transmissionbt.com/job/trunk-linux-inc/ and follow the steps from the previous section.
 
-    If you're new to building programs from source code, this is typically 
-    easier than building from SVN.
+If you're new to building programs from source code, this is typically easier than building from SVN.
 
-  Building Transmission from SVN (First Time):
+### Building Transmission from SVN (first time)
 
     $ svn co svn://svn.transmissionbt.com/Transmission/trunk Transmission
     $ cd Transmission
@@ -42,14 +36,15 @@ BUILDING
     $ make
     $ sudo make install
 
-  Building Transmission from SVN (Updating):
+### Building Transmission from SVN (updating)
 
     $ cd Transmission
     $ make clean
     $ svn up
-    $ ./update-version-h.sh 
+    $ ./update-version-h.sh
     $ make
     $ sudo make install
 
-  Notes for building on Solaris' C compiler:  User av reports success with
-  this invocation: ./configure CC=c99 CXX=CC CFLAGS='-D__EXTENSIONS__ -mt'
+Notes for building on Solaris' C compiler: User av reports success with this invocation:
+
+    ./configure CC=c99 CXX=CC CFLAGS='-D__EXTENSIONS__ -mt'