Commits

Yaron Minsky committed 95bae6d

more detail in the README

Comments (0)

Files changed (1)

 to get better error messages from the compiler when using Core.  (As
 of 4.01, this compiler variant should be obsolete.)
 
-You can build the project by running:
+You can build all the pieces of this project by running:
+
+    $ ./build_all.sh
+
+Or you can build any individual executable by running
 
     $ ./build.sh hello_world.native
 
-and you can then use it as follows:
+There are three basic examples
+
+Hello World
+-----------
+
+This executable is `hello_world.native` (or `hello_world.byte`), and
+here's an example of it in action.
 
     core-hello-world $ ./hello_world.native
     Hello World!
     core-hello-world $ ./hello_world.native -hello "Goodbye" -world "Yellow Brick Road"
     Goodbye Yellow Brick Road!
 
+
+Hello World client/server
+-------------------------
+
+The next example is a pair of programs: `hello_server.native` and
+`hello_client.native`.  The server will accept requests via the
+`Async.Rpc` library, and the client dispatches them.  The RPC is
+trivial: the client sends a string, and the server attaches " World!"
+to the end of it and sends the result back.
+
+Message Broker
+--------------
+
+This is the most complicated example.  `broker_server.native` is a
+simple message broker that allows you to publish and subscribe to
+streams of data.  `broker_client.native` is a client that lets you do
+a few operations, including publishing, subscribing, getting a dump of
+the current state of the server, and shutting the server down.
+
+Setting up the toplevel
+-----------------------
+
 There's also a file called dot_ocamlinit, which will auto-load Core
 for you in the toplevel, if you do this:
 
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.