Skip to content

Commit 2614cda

Browse files
committed
Updated README.
1 parent 4572ced commit 2614cda

File tree

1 file changed

+9
-113
lines changed

1 file changed

+9
-113
lines changed

README.md

Lines changed: 9 additions & 113 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## NitroShare
22

3-
[![](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](http://opensource.org/licenses/MIT)
3+
[![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](http://opensource.org/licenses/MIT)
44
[![Join the chat at https://gitter.im/nitroshare/nitroshare-desktop](http://img.shields.io/badge/gitter-JOIN_CHAT-green.svg?style=flat)](https://gitter.im/nitroshare/nitroshare-desktop?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
55

66
A cross-platform network file transfer application designed to make transferring any file to any device as painless as possible.
@@ -10,121 +10,17 @@ A cross-platform network file transfer application designed to make transferring
1010
* Runs on Windows / Mac OS X / Linux
1111
* Automatic discovery of devices on the local network
1212
* Simple and intuitive user interface
13+
* Incredibly fast transfer speeds
1314
* Transfer entire directories
15+
* Optional TLS encryption
16+
* Local HTTP API
1417
* Completely free and open-source
1518

16-
### Build Requirements
19+
### Download
1720

18-
The requirements for building NitroShare are as follows:
21+
Downloads can be found on the NitroShare website:
22+
https://nitroshare.net
1923

20-
* CMake 3.2.0+
21-
* C++ compiler with support for C++11:
22-
* Microsoft Visual C++ 2013+
23-
* GCC 4.7+
24-
* Clang 3.1+
25-
* Qt 5.1+ (Qt 5.3+ required for building installers)
24+
### Documentation
2625

27-
On supported Linux platforms, NitroShare can be built with support for [application indicators](https://unity.ubuntu.com/projects/appindicators/). This feature is enabled when the following development packages are installed:
28-
29-
* GTK+ 2
30-
* libappindicator
31-
* libnotify
32-
33-
### Building the Application
34-
35-
The instructions below describe the build process for each of the supported platforms.
36-
37-
#### Ubuntu 14.04, 14.10, 15.04, & 15.10
38-
39-
1. Versions of Ubuntu prior to 15.10 (Wily Werewolf) include an outdated version of CMake and therefore you will need to add the following PPA before installing CMake:
40-
41-
sudo add-apt-repository ppa:george-edison55/cmake-3.x
42-
sudo apt-get update
43-
44-
2. Install GCC, CMake, and the Qt 5 development files:
45-
46-
sudo apt-get install build-essential cmake qtbase5-dev
47-
48-
To enable support for application indicators, you will need to install the following packages:
49-
50-
sudo apt-get install libgtk2.0-dev libappindicator-dev libnotify-dev
51-
52-
2. Change to the root of the source directory and build the project:
53-
54-
mkdir build && cd build
55-
cmake ..
56-
make
57-
58-
3. The NitroShare binary will be in the `out/` directory and can be run with:
59-
60-
out/nitroshare
61-
62-
#### Windows 7, 8, 8.1, and 10
63-
64-
1. Download and install the following tools:
65-
66-
- [Visual Studio Express 2013 for Windows Desktop](http://go.microsoft.com/?linkid=9832280&clcid=0x409) [requires sign-in]
67-
- [CMake](https://cmake.org/download/)
68-
- [Qt Online Installer for Windows](http://www.qt.io/download-open-source/)
69-
70-
2. Ensure that the `bin` directory for Qt has been added to the `PATH` environment variable.
71-
72-
3. Open the appropriate command prompt for Visual C++. In Visual C++ 2013, these shortcuts are labeled as follows:
73-
74-
- VS2013 x86 Native Tools Command Prompt
75-
- VS2013 x64 Cross Tools Command Prompt
76-
77-
4. Change to the root of the source directory and build the project
78-
79-
mkdir build && cd build
80-
cmake -G"NMake Makefiles" -DCMAKE_BUILD_TYPE=Release ..
81-
nmake
82-
83-
5. The NitroShare binary will be in the `out\` directory and can be run with:
84-
85-
out\nitroshare.exe
86-
87-
> **Note:** if you receive an error similar to "The program can't start because [...].dll is missing from your computer.", then you will need to manually copy the Qt DLLs to the same directory as the executable. (This is done automatically for Qt 5.2+.)
88-
89-
#### OS X 10.7, 10.8, 10.9, 10.10, & 10.11
90-
91-
1. Download and install the following tools:
92-
93-
- [Xcode](https://itunes.apple.com/ca/app/xcode/id497799835?mt=12)
94-
- [CMake](https://cmake.org/download/)
95-
- [Qt Online Installer for Mac](http://www.qt.io/download-open-source/)
96-
97-
2. Ensure that the `bin` directory for CMake and Qt have been added to `/etc/paths`.
98-
99-
3. Open the terminal app, change to the root source directory, and build the project:
100-
101-
mkdir build && cd build
102-
cmake ..
103-
make
104-
105-
4. The NitroShare bundle will be in the `out/` directory and can be run with:
106-
107-
open out/nitroshare.app
108-
109-
### Building the Installers and Packages
110-
111-
The instructions below describe the steps necessary to create installers or packages on each of the supported platforms.
112-
113-
#### Ubuntu
114-
115-
Debian packaging for NitroShare can be found here:
116-
https://github.com/nitroshare/nitroshare-desktop-debian
117-
118-
#### Windows
119-
120-
Building the installers for 32 and 64-bit editions of Windows requires [Inno Setup](http://www.jrsoftware.org/isinfo.php).
121-
122-
Run the following command to build a Windows EXE installer:
123-
124-
nmake exe
125-
126-
#### OS X
127-
128-
Run the following command to build a compressed disk image:
129-
130-
make dmg
26+
Instructions for building NitroShare from source as well as protocol descriptions can be found on [the GitHub wiki](https://github.com/nitroshare/nitroshare-desktop/wiki).

0 commit comments

Comments
 (0)