blob: 38410687a31434bfcb8ae541380e55c8926d06d7 [file] [log] [blame]
Zhenkai Zhu487f8b62012-10-01 13:47:59 -07001Chronos is a multiparty chat application that demostrates our work on sync (high level idea is similar to ccnx sync, but the design is slightly different).
2
3Chronos will have binary package for Mac OS X 10.7 and 10.8 hopefully by the time of the next retreat. However, it's too much work to do binary packaging for different flavors of Linux, so Linux users will have to compile by their own.
4
Zhenkai Zhua8cd2bd2012-10-10 14:10:14 -07005If you are following Alex A's suggestion and installed his package of ccnx, you don't have to input the name prefix for your data manually. However, if you haven't installed his ccnx package, or your hub does not support prefix auto configuration, you'll have to manually input a routable prefix for your data.
6
Zhenkai Zhu487f8b62012-10-01 13:47:59 -07007Note that after you click to close Chronos, it will be running on your system tray. To restore it to normal size window, you have to click on the system tray icon (normally on the upper right corner of your screen). Clicking on the dock won't work for now and is still on the to-do list (because I'm using qt for gui, not the native Cocoa framework).
8
Zhenkai Zhua8cd2bd2012-10-10 14:10:14 -07009== Known Issues ==
101. When you switch to a new room, you'll temporarily see yourself in two nodes for a minute or so. It won't affect others, just yourself. Hopefully it's not so disturbing.
112. Sometimes you may not get the most up-to-date chat history.
12
13== For those who wants (or is forced to) compile from source code ==
14
Zhenkai Zhu487f8b62012-10-01 13:47:59 -070015You need pkg-config, protobuf, boost, and qt to compile this app. All of them can be installed through macports.
16The following command should do it:
17$ sudo port install pkg-config protobuf-cpp boost qt4-mac
18
19To compile this app:
Zhenkai Zhu5f52d882012-10-01 13:51:02 -0700201. in the top directory, check out the "sync" submodule
Zhenkai Zhu487f8b62012-10-01 13:47:59 -070021$ git submodule update --init
22
232. go to sync directory, do:
24$ ./waf configure
25$ ./waf
26$ sudo ./waf install
27
283. back to the top directory, set up environment for pkg-config, make sure libsync.pc is searchable, this is mine:
29$ export PKG_CONFIG_PATH=/opt/local/lib/pkgconfig:/usr/local/lib/pkgconfig:/usr/lib/pkgconfig
30
314. compile Chronos:
32$ qmake
33$ make
34
35Congratulations! Chronos.app is ready to use (on a Mac).
36