New README

This commit is contained in:
Naim A 2016-01-21 15:40:48 -08:00
parent 1de524cb99
commit 5842706d29
3 changed files with 40 additions and 20 deletions

1
.gitignore vendored
View file

@ -1 +1,2 @@
*.o
*.sublime-*

20
README
View file

@ -1,20 +0,0 @@
What is UDPT?
The UDPT project is a BitTorrent Tracking software.
It uses the UDP protocol (instead of the HTTP protocol) to track
peers downloading the same software. UDPT was written according
to BEP 15 of the BitTorrent standard.
Who Wrote UDPT, and when?
UDPT's development started on Nevember 20th, 2012.
It was written by Naim A. <naim94a@gmail.com>. Naim wrote this
program for fun in his free time.
Required Software:
UDPT depends on SQLite3 (public-domain, compatible with GPL).
UDPT's source is designed to be platform portable. It is
supported with Windows and with Linux based systems, It should
work with Apple's systems but it might not (no officially supported).
Project page: http://www.github.com/naim94a/udpt

39
README.md Normal file
View file

@ -0,0 +1,39 @@
# UDPT
The UDPT project is a BitTorrent Tracking software.
It uses the UDP protocol (instead of the HTTP protocol) to track
peers downloading the same software. UDPT was written according
to [BEP 15](http://www.bittorrent.org/beps/bep_0015.html) of the BitTorrent standard.
UDPT is designed to run on both Windows and Linux-based platform (It may run on Apple systems too).
### License
UDPT is released under the [GPL](http://www.gnu.org/licenses/gpl-3.0.en.html) license, a copy is included in this repository.
We use [SQLite3](http://www.sqlite.org/) which is public-domain.
### Building
We didn't really work on creating any installer, at the moment you can just run udpt from anywhere on your filesystem.
Building udpt is pretty straightforward, just download the project or clone the repo:
UDPT requires the SQLite3 develpment package to be installed.
<pre>
$ git clone https://github.com/naim94a/udpt.git
$ cd udpt
$ make
</pre>
And finally:
<pre>
$ ./udpt
</pre>
### Links
* Documentation can be found at our wiki: https://github.com/naim94a/udpt/wiki
* If you have any suggestions or find any bugs, please report them here: https://github.com/naim94a/udpt/issues
* Project Page: http://www.github.com/naim94a/udpt
### Author(s)
UDPT was developed by [Naim A.](http://www.github.com/naim94a) at for fun at his free time.
The development started on November 20th, 2012.