From 5842706d29bf444a935dc25d7d2e2a0f979adf4c Mon Sep 17 00:00:00 2001 From: Naim A Date: Thu, 21 Jan 2016 15:40:48 -0800 Subject: [PATCH] New README --- .gitignore | 1 + README | 20 -------------------- README.md | 39 +++++++++++++++++++++++++++++++++++++++ 3 files changed, 40 insertions(+), 20 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/.gitignore b/.gitignore index 5761abc..8c483d3 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ *.o +*.sublime-* diff --git a/README b/README deleted file mode 100644 index a941a6a..0000000 --- a/README +++ /dev/null @@ -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. . 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 - diff --git a/README.md b/README.md new file mode 100644 index 0000000..82b0d2a --- /dev/null +++ b/README.md @@ -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. + +
+    $ git clone https://github.com/naim94a/udpt.git
+    $ cd udpt
+    $ make
+
+ +And finally: + +
+    $ ./udpt
+
+ +### 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.