Skip to content

Commit beb00ec

Browse files
committed
Update README to be slightly less stale.
We are still missing decent first-time user docs, but this helps a bit. Fixes RAM-326.
1 parent 546dd60 commit beb00ec

File tree

1 file changed

+33
-17
lines changed

1 file changed

+33
-17
lines changed

README

+33-17
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
@mainpage RAMCloud
33

44

5-
See http://fiz.stanford.edu:8081/display/ramcloud/Contributing for further details.
5+
See https://ramcloud.stanford.edu/wiki/display/ramcloud/General+Information+for+Developers for further details.
66

77

88

@@ -30,37 +30,54 @@ Using GNU make, type:
3030

3131
$ make
3232

33-
# make install
34-
35-
This will build the client, server, and backups. The install step
36-
simply installs the RAMCloud client library and headers in /usr/local.
37-
33+
This will build the client, server, and coordinator.
3834

3935
====================================
4036
2. Running
4137
====================================
4238

43-
To run you must have 3 things. A running backup, a running server,
44-
and some kind of client. Note that the backup must be started first.
39+
To run you must have 3 things. A running coordinator, a running master,
40+
and some kind of client. These all need to be run on the same host;
41+
running on separate hosts requires more flags (see -C and -L on both
42+
the coordinator and server binary).
4543

46-
2.1 Starting a backup
44+
2.1 Starting a coordinator
4745

48-
$ ./obj.master/backup
46+
$ ./obj.master/coordinator
4947

5048
2.2 Starting a server
5149

52-
$ ./obj.master/server
50+
$ ./obj.master/server -M -r 0
51+
52+
This starts a RAMCloud process acting only as a master using 0 backups.
53+
If the master can communicate with the coordinator process you should
54+
see a log message ending with "My server ID is 1" after a second or so.
55+
56+
2.3
57+
58+
To make sure things are really working try running
5359

54-
2.3 Using the libramcloud.so library
60+
$ ./obj.master/client
61+
62+
It should connect to the master and perform a few random operations.
63+
If it is working then you have a working basic RAMCloud and you can
64+
start writing more interesting applications.
65+
66+
2.4 Using the libramcloud.so library
5567

5668
Write a client application using the interface described in
57-
/usr/local/include/ramcloud/client.h. Compile with:
69+
src/RamCloud.h (see RamCloudMain.cc for an example).
70+
71+
Until we have a proper 'install' target compile with:
5872

59-
$ gcc -lramcloud -I/usr/local/include/ramcloud -o test-client test-client.c
73+
$ g++ -Lobj.master -lramcloud -Isrc -Iobj.master -o TestClient TestClient.cc
6074

61-
2.4 Using the Python bindings:
75+
This is assuming TestClient.cc is in the ramcloud directory just above src.
76+
Adjust your paths accordingly.
6277

63-
$ PYTHONPATH=bindings/python python
78+
2.5 Using the Python bindings:
79+
80+
$ LD_LIBRARY_PATH=$LD_LIBRARY_PATH:obj.master PYTHONPATH=bindings/python python
6481

6582
>>> import ramcloud
6683

@@ -76,7 +93,6 @@ $ PYTHONPATH=bindings/python python
7693
====================================
7794
3. Testing
7895
====================================
79-
8096
3.1 Static Style Checking
8197

8298
$ make check

0 commit comments

Comments
 (0)