← Back to branch summary

~mateo-salta/nitroshare/nitroshare

« back to all changes in this revision

Viewing changes to README

  • Committer: Nathan Osman
  • Date: 2012-06-21 22:34:44 UTC
  • Revision ID: admin@quickmediasolutions.com-20120621223444-y79awz4v3ymqcx0w
Added README.

Show diffs side-by-side

added added

removed removed

Lines of Context:
README
 
1
NitroShare - A Tool for Sharing Files over a Local Network
 
2
Copyright 2012 - Nathan Osman
 
3
 
 
4
INTRODUCTION
 
5
 
 
6
Have you ever sat down in front of your computer and realized that you need a
 
7
file that's stored on another machine on your local network? You immediately
 
8
begin thinking of ways to transfer the file. If both machines are using the same
 
9
operating system, you might be able to simply mount the drive on the remote
 
10
machine containing the file. If not, you might have to resort to using a flash
 
11
drive or a commercial syncing service like DropBox. If things really get out of
 
12
hand, you might even find yourself setting up an FTP server. It seems like there
 
13
should be an easier way to just transfer a file.
 
14
 
 
15
There is. NitroShare.
 
16
 
 
17
This tool takes the hassle out of transferring files from one machine to another
 
18
over your local network. Simply drag the file on to the Share Box and pick which
 
19
machine you want to send it to. That's it. It doesn't matter if the other
 
20
machine is running Windows or Linux. NitroShare just works.
 
21
 
 
22
FEATURES
 
23
 
 
24
- Automatic discovery of other machines on the local network.
 
25
- Ability to send one or many files across the network.
 
26
- Support for compressing the files and performing CRC checks upon arrival.
 
27
- Compiles and runs on all platforms supported by Qt (Windows, Mac, Linux)
 
28
- Integrates with the host OS, using application indicators on Ubuntu and the
 
29
  system tray on Windows, for example.
 
30
- A large number of settings that you can tweak for maximum performance.
 
31
- Completely open source (released under the GPLv3).
 
32
 
 
33
COMPILING
 
34
 
 
35
Because NitroShare is written in C++ and uses the cross-platform Qt framework,
 
36
you can build the program on a number of different platforms. Before building,
 
37
you need to make sure you have the following tools and libraries installed:
 
38
 
 
39
- Qt SDK (4.7 or later)
 
40
- QJson
 
41
- Bazaar (for fetching the latest NitroShare source code)
 
42
 
 
43
The basic build instructions are as follows:
 
44
 
 
45
1. Create a folder and grab the latest source code for NitroShare from
 
46
   Launchpad:
 
47
 
 
48
   mkdir nitroshare
 
49
   cd nitroshare
 
50
   bzr pull lp:nitroshare
 
51
 
 
52
2. Build the project.
 
53
 
 
54
   qmake
 
55
   make