Paul Ruane avatar Paul Ruane committed 6a608ab

Update doc.

Comments (0)

Files changed (1)

 Compiling
 ---------
 
+The following steps are for compiling from source. Compiled binaries for some
+platforms are available from the tmsu project page on Bitbucket.
+
 tmsu is written in Go (http://www.golang.org/). To compile from source you
-must first install Go and the Go packages that tmsu depends upon.
+must first install Go and the packages that tmsu depends upon.
 
 1. Installing Go
 
 or it may be available in the package management system that comes with your
 operating system (if any).
 
-tmsu is currently built against the Go weekly builds (see `VERSIONS`).
+tmsu is currently built against the Go weekly builds (see `VERSIONS` for exact
+revision numbers).
 
 2. Install the dependent packages
 
-    > goinstall gosqlite.googlecode.com/hg/sqlite
+    > goinstall github.com/mattn/go-sqlite3
     > goinstall github.com/hanwen/go-fuse/fuse
 
-3. Make the project
+At the time of writing the go-fuse project does not have a Makefile so must
+be compiled manually:
 
+    > cd $GOROOT/src/pkg/github.com/hanwen/go-fuse
+    > ./all.bash
+
+3. Checkout the tmsu source code:
+
+    > hg co https://bitbucket.org/oniony/tmsu
+
+4. Make the project
+
+    > cd tmsu
     > make
 
-This will produce a bin directory containing the resultant binary.
+This will compile to 'bin/tmsu' within the working directory.
+
+5. Install the project
+
+    > sudo make install
 
 - - -
 
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.