Steven! Ragnarök avatar Steven! Ragnarök committed c721b9e

Update README with better instructions.

Comments (0)

Files changed (2)

README

-# messageme
-
-Every time I look at Java, I think to myself
-
-> Oh, this shit again.
-
-## Usage
-
-Coming Soon.
-
-## License
-
-Copyright (C) 2012 Steven! Ragnarök
-
-Distributed under the GPL V3 or Later.
+messageme.clj
+=============
+
+Every time I look at Java, I think to myself
+
+> Oh, this shit again.
+
+Getting It
+==========
+
+This project uses Mercurial for version control and can so be fetched with
+
+`hg clone https://bitbucket.org/nuclearsandwich/messageme-clj`
+
+or go to <https://bitbucket.org/nuclearsandwich/messageme-clj> and select your
+preferred archive format from the "get source" tab.
+
+Building It
+===========
+
+As every Clojure project should be, messageme.clj is build using [Leiningen][]
+I've included the Leiningen bootstrap script `bin/lein` as part of this repo
+for your convenience.
+
+Since Clojure is dynamically compiled, open a REPL to test that it builds.
+
+`./bin/lein repl`
+
+Running It
+==========
+
+The program can be run using leiningen as well. Do to a bug in Ant, it must be
+trampolined (spawns a separate JVM rather than using leiningen's).
+
+`./bin/lein trampoline run`
+Ant eats stdin.
+
+## License
+
+Copyright (C) 2012 Steven! Ragnarök
+
+Distributed under the GPL V3 or Later.
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.