From 613f98f98facfee817ca90c6170b8b93e2bc2150 Mon Sep 17 00:00:00 2001 From: David Renshaw Date: Fri, 16 May 2014 22:37:25 -0400 Subject: [PATCH] omit needless words --- README.md | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 70112a5..9ba8750 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,17 @@ # capnproto-java: Cap'n Proto for Java -This is an experimental pure Java implementation of Cap'n Proto. +This is an experimental pure Java implementation of [Cap'n Proto](http://capnproto.org). -It doesn't do much yet. An attempt to use SBT as the build system and integration with `make` is currently underway. +It doesn't do much yet. -To get started with SBT, visit https://github.com/paulp/sbt-extras or to run direct, try `curl -s https://raw.githubusercontent.com/paulp/sbt-extras/master/sbt > ~/bin/sbt && chmod 0755 ~/bin/sbt` +## getting started -When you first build the project, try running `sbt update gen-idea`. This will bootstrap SBT and generate IntelliJ project files for those who wish to develop in an IDE. - -When running `make`, the supporting Java code will be built, and the sample schema will be run through the code generator as well to produce the Java binding. You can find the generated code in `/examples/src/main/generated/Addressbook.java` - -Example of building and running from the command line: +You will need [SBT](http://scala-sbt.org). We recommend [this version](https://github.com/paulp/sbt-extras). ``` -$ make CXX_FLAGS="-std=c++11 -I/usr/local/include -L/usr/local/lib -lcapnp -lkj" +$ sbt compile $ echo '(people = [(id = 123, name = "Alice", email = "alice@example.com", employment = (school = "MIT"))])' | capnp encode examples/src/main/schema/addressbook.capnp AddressBook | java -cp generator/target/scala-2.11/classes:examples/target/scala-2.11/classes/ org.capnproto.examples.AddressbookMain read -``` \ No newline at end of file +``` + +To generate IntelliJ project files, do `sbt update gen-idea`. +