Merge branch 'master' of ssh://repo.or.cz/srv/git/bitfountain
[bitfountain.git] / README
blob5b9d0b4cebcee56b6e20be88b85054f1b4363182
1 Bitfountain - Communist file sharing over wifi
2 ==============================================
4 Running the app (Milestone 2)
5 -----------------------------
7 The .tar.bz2 we gave you is an Eclipse project. Just import it in Eclipse
8 and you're good to go.
10 First, launch a org.bitfountain.gui.server.ServerApp
11 This will display a Log/Preferences window for the server.
13 Then, launch as many org.bitfountain.gui.client.ClientApp as you want.
14 Each of them will open a 'Login' window which you can use to connect
15 to the server you just launched.
17 Go in the 'Téléversement' tab and click 'Téléverser' to upload a file
18 to the server. When it's finished, you should see a notification
19 that a new file is available on the server. You can browse available
20 files in the 'Catalogue' tab.
22 From the 'Catalogue' tab, you can select a file from the list and click
23 on the download icon on the right of the list item to start downloading it.
25 Downloads are listed in the 'Téléchargements' onglet. Their progress is 
26 shown, along with download speed, total size, etc. The buttons allow
27 to cancel a download, open it with the OS's application for it, or remove
28 it from the list.
30 You can of course run the server and the clients on different machine,
31 just change the IP in the Login box so they can all interact.
33 The server supports concurrent uploads and downloads from multiple
34 clients at once, and clients can download/upload multiple files at
35 the same time too! But don't take our word for it, try it for yourself!
37 Enjoy,
38 Amos Wenger & Rivo Vasta