From 12ad456f50b7d5a34d3430f2db2ebe0e1d5aac70 Mon Sep 17 00:00:00 2001 From: Mike Gelfand Date: Fri, 2 Sep 2016 01:04:13 +0300 Subject: [PATCH 1/2] Rename README to README.md --- README => README.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename README => README.md (100%) diff --git a/README b/README.md similarity index 100% rename from README rename to README.md From 24cdb31a0d30bb156a60d83d7027c7b61b1a9c5e Mon Sep 17 00:00:00 2001 From: Mike Gelfand Date: Fri, 2 Sep 2016 01:07:32 +0300 Subject: [PATCH 2/2] Fix readme formatting to use proper markdown --- README.md | 45 ++++++++++++++++++++------------------------- 1 file changed, 20 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 395136fb3..74aef0862 100644 --- 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'