Skip to content

Commit 31cbe1d

Browse files
committed
Finished readme
1 parent 10739c0 commit 31cbe1d

File tree

1 file changed

+25
-3
lines changed

1 file changed

+25
-3
lines changed

readme.md

+25-3
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,39 @@
11
# qMakeTorrent
22
* Current version: 1.0.0
33
* Author: whitehat2k9
4-
* License: GNU General Public License v3
4+
* License: Copyright 2013, GNU General Public License v3
5+
* Website: <http://whitehat2k9.github.com/qMakeTorrent
56

67
## Description
78
qMakeTorrent is an advanced torrent creator with batch capability.
89

910
## Installation
10-
### Linux
11+
### Linux/UNIX
1112
Requires a Qt4 development environment, C++/Boost 1.46+, and a recent version of libtorrent
13+
1214
$ qmake
1315
$ make
1416

1517
### Windows
16-
Windows binaries can be found here.
18+
Windows binaries can be found on the project page above.
19+
20+
### Mac
21+
In theory compilation should be the same as on Linux/UNIX. If someone wishes to contribute binaries
22+
I will be more than happy to post them.
23+
24+
25+
## Usage
26+
1. Click "Add File" or "Add Directory" to select an input file or directory. If a directory is
27+
selected, the option to use batch mode will be enabled. In batch mode, qMakeTorrent creates a torrent
28+
for each subdirectory directly below the input path.
29+
2. Next, you will be asked to choose an output path for your torrent(s). If your input was a single file
30+
or directory, you will be asked to choose the save location of the .torrent file. If your input was a directory
31+
with batch mode enabled, you will be asked to choose a directory in which to save the .torrent files. In this case,
32+
each torrent will be named <subdirectory name>.torrent.
33+
3. On the next page, set the creator, comment, piece size, and private flag as desired.
34+
4. Wait for your torrents to be created.
35+
36+
## Support
37+
Please use the GitHub Issue Tracker and pull request system to report bugs/issues and submit improvements/changes, respectively.
38+
1739

0 commit comments

Comments
 (0)