Gitiles
Code Review Sign In
gerrit.named-data.net / ChronoChat / 0b21e29955804169f4a3b3a5978817dde9b6d1e8 / . / README.md
blob: 7d28d23f60850f9560b9b2403a5c21d9b21d43fd [file] [log] [blame] [view]
Alexander Afanasyevb4b92292013-07-09 13:54:59 -0700[diff] [blame]1ChronoChat
2==========
3
4ChronoChat is a multiparty chat application that demostrates our synchronization primitive that we call ChronoSync.
5
6Note that after you click to close ChronoChat, it will keep 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).
7
8## Known Issues
9---------------
10
111. 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.
122. Sometimes you may not get the most up-to-date chat history.
13
14## For those who wants (or is forced to) compile from source code
15-----------------------------------------------------------------
16
Alexander Afanasyeveb7ee6b2013-07-13 16:20:09 -0700[diff] [blame]17### Compilation steps for OSX
Alexander Afanasyevb4b92292013-07-09 13:54:59 -0700[diff] [blame]18
Alexander Afanasyev49abb912014-05-09 15:23:48 -0700[diff] [blame]191. Install MacPorts, if not yet installed (http://www.macports.org/), configure [NDN ports repository](http://named-data.net/doc/NFD/current/FAQ.html#how-to-start-using-ndn-macports-repository-on-osx) and install NFD if you don't have it yet.
Alexander Afanasyevb4b92292013-07-09 13:54:59 -0700[diff] [blame]20
Alexander Afanasyev49abb912014-05-09 15:23:48 -0700[diff] [blame]21 sudo port install nfd
22 sudo nfd-start
Alexander Afanasyevb4b92292013-07-09 13:54:59 -0700[diff] [blame]23
Alexander Afanasyev49abb912014-05-09 15:23:48 -0700[diff] [blame]242. Install ChronoChat dependencies
Alexander Afanasyevb4b92292013-07-09 13:54:59 -0700[diff] [blame]25
Alexander Afanasyeveb7ee6b2013-07-13 16:20:09 -0700[diff] [blame]26 sudo port install pkgconfig protobuf-cpp boost qt4-mac
Alexander Afanasyevb4b92292013-07-09 13:54:59 -0700[diff] [blame]27
Alexander Afanasyeveb7ee6b2013-07-13 16:20:09 -0700[diff] [blame]283. Fetch source code with submodules
Alexander Afanasyevb4b92292013-07-09 13:54:59 -0700[diff] [blame]29
Alexander Afanasyevdf7e5692013-07-15 12:43:12 -0700[diff] [blame]30 git clone --recursive git://github.com/named-data/ChronoChat
Alexander Afanasyevb4b92292013-07-09 13:54:59 -0700[diff] [blame]31
Alexander Afanasyeveb7ee6b2013-07-13 16:20:09 -0700[diff] [blame]32If you already cloned repository, you can update submodules this way:
33
Alexander Afanasyevdf7e5692013-07-15 12:43:12 -0700[diff] [blame]34 git submodule update --init
Alexander Afanasyeveb7ee6b2013-07-13 16:20:09 -0700[diff] [blame]35
Alexander Afanasyevdf7e5692013-07-15 12:43:12 -0700[diff] [blame]364. Configure and install ChronoSync
Alexander Afanasyeveb7ee6b2013-07-13 16:20:09 -0700[diff] [blame]37
Alexander Afanasyevdf7e5692013-07-15 12:43:12 -0700[diff] [blame]38 cd ChronoChat/ChronoSync
39 ./waf configure
40 ./waf
41 sudo ./waf install
42
Alexander Afanasyeveb7ee6b2013-07-13 16:20:09 -0700[diff] [blame]435. Configure and build ChronoChat
44
45 cd ..
46 PKG_CONFIG_PATH=/opt/local/lib/pkgconfig:/usr/local/lib/pkgconfig:/usr/lib/pkgconfig ./waf configure
47 ./waf
Alexander Afanasyevb4b92292013-07-09 13:54:59 -0700[diff] [blame]48
49Congratulations! build/ChronoChat.app is ready to use (on a Mac).
50
Alexander Afanasyev49abb912014-05-09 15:23:48 -0700[diff] [blame]51### Compilation steps for Ubuntu 12.04, 13.10, 14.04
Alexander Afanasyeveb7ee6b2013-07-13 16:20:09 -0700[diff] [blame]52
Alexander Afanasyev49abb912014-05-09 15:23:48 -0700[diff] [blame]531. Configure [NDN PPA repository](http://named-data.net/doc/NFD/current/FAQ.html#how-to-start-using-ndn-ppa-repository-on-ubuntu-linux) and install NFD if you don't have it yet.
Alexander Afanasyeveb7ee6b2013-07-13 16:20:09 -0700[diff] [blame]54
Alexander Afanasyev49abb912014-05-09 15:23:48 -0700[diff] [blame]55 sudo apt-get install nfd
Alexander Afanasyeveb7ee6b2013-07-13 16:20:09 -0700[diff] [blame]56
Alexander Afanasyev49abb912014-05-09 15:23:48 -0700[diff] [blame]572. Install ChronoChat dependencies
58
Alexander Afanasyeveb7ee6b2013-07-13 16:20:09 -0700[diff] [blame]59 sudo apt-get install libprotobuf-dev protobuf-compiler libevent-dev
60 sudo apt-get install libboost1.48-all-dev
61 sudo apt-get install qt4-dev-tools
62
Alexander Afanasyeveb7ee6b2013-07-13 16:20:09 -0700[diff] [blame]633. Fetch source code with submodules
64
Alexander Afanasyevdf7e5692013-07-15 12:43:12 -0700[diff] [blame]65 git clone --recursive git://github.com/named-data/ChronoChat
Alexander Afanasyeveb7ee6b2013-07-13 16:20:09 -0700[diff] [blame]66
67If you already cloned repository, you can update submodules this way:
68
Alexander Afanasyevdf7e5692013-07-15 12:43:12 -0700[diff] [blame]69 git submodule update --init
Alexander Afanasyeveb7ee6b2013-07-13 16:20:09 -0700[diff] [blame]70
Alexander Afanasyevdf7e5692013-07-15 12:43:12 -0700[diff] [blame]714. Configure and install ChronoSync
Alexander Afanasyeveb7ee6b2013-07-13 16:20:09 -0700[diff] [blame]72
Alexander Afanasyevdf7e5692013-07-15 12:43:12 -0700[diff] [blame]73 cd ChronoChat/ChronoSync
74 ./waf configure
75 ./waf
76 sudo ./waf install
Alexander Afanasyeveb7ee6b2013-07-13 16:20:09 -0700[diff] [blame]77 sudo ldconfig
78
795. Configure and build ChronoChat
80
81 cd ..
82 ./waf configure
83 ./waf
84
85Congratulations! build/ChronoChat is ready to use. Do not forget to start ccnd and configure FIB before using ChronoChat.