source: trunk/Readme.txt @ 358

Revision 358, 5.4 KB checked in by Eoin, 13 years ago (diff)

0.3 rc

Line 
1Halite: A Free Open-Source BitTorrent client
2
3Version: 0.3 released 26th December 2007
4
5WWW: http://www.binarynotions.com/halite.php Forum:
6http://www.binarynotions.com/forum.php
7
8Developer: Eóin O'Callaghan
9
10Halite (named after the mineral) is a BitTorrent client based on Arvid
11Norberg's excellent libtorrent library from Rasterbar Software. The
12program also relies on the Boost libraries.
13
14Features:
15
16While still at an early state of development Halite is a functional
17BitTorrent client. So far its list of features is pretty standard but
18that is because I want to ensure it does the basic stuff well.
19
20That said, it supports:
21
22  + File selection and/or file priority specifications.
23  + Trackerless torrents (using the Mainline kademlia DHT protocol).
24  + IP filtering with eMule style ipfilter.dat import.
25  + Protocol Encryption support.
26  + Translations of the UI into a number of languages through the help
27    of volunteers. (if you wish to help with a translation then please do)
28  + Minimize to tray with transfer rate summary.
29  + Full Unicode support through UTF-8 and native Windows wide-char strings.
30  + Login support where tracker requires it.
31  + Ability to edit trackers specified in the torrent.
32  + Transfer rate and connection limits both global and per-torrent.
33
34Requirements: Windows 2000, XP, Server 2003 and Vista (Note currently
35Vista users need to install the application to a directory where they
36will have full read and write access to. The recommended solution is
37to use the standalone exe distribution and not the installer.
38
39Known Issues/Problems:
40
41Halite does not always gracefully accept configuration information
42from previous versions. Should you experience crashes upon running
43Halite you should delete any old Halite.ini.xml or Halite.xml.
44
45You will not lose any downloads in progress and those which do not
46restart automatically can be done so manually by loading the
47associated torrent file from the 'torrents' subdirectory.
48
49Changes:
50
51 - from v 0.2.9 to 0.3:
52   1) File selection and/or priority settings.
53   2) Protocol Encryption.
54   3) New tabbed interface makes better use of screen real estate.
55   4) Updated to recent versions of Boost (1.34.1) and libtorrent.
56   5) Numerous bug fixes.
57   
58 - from v 0.2.8 to 0.2.9:
59   1) Full Unicode support!
60   2) Rewitten XML fileformat with greatly improved robustness.
61   3) New tabbed interface makes better use of screen real estate.
62   4) Ability to edit Trackers and set login details.
63   5) Comprehensive logging for diagnosing problems.
64   6) Windows 2000 and Server 2003 supported fully.
65   7) Switched to MSVC 2005 compiler (8.0) for improved reliability
66      though at the cost of slightly bigger executables.
67   
68- from v 0.2.7 to 0.2.8:
69   1) IP filtering support eMule style ipfilter.dat files.
70   2) DHT support, thought it is turned off by default.
71   3) Can select alternate save directory for torrents..
72   4) New icon!
73
74 - from v 0.2.6 to 0.2.7:
75   1) By default Halite will only allow one instance to be launched
76   2) Halite can be set as the default program for '.torrent' files.
77   3) ETA indicator for torrents. 4) Minor GUI tweaks.
78
79 - from v 0.2.5 to 0.2.6:
80   1) Fixed a silly bug (i.e. I should have caught it sooner) whereby
81      exiting Halite from the tray would screw up the window layout
82      next time running it.
83   2) Added auto-selection to Torrents list to make it more intuitive.
84
85 - from v 0.2 to 0.2.5:
86   1) The GUI is slightly altered so that it looks consistent and neat
87      for a number of visual styles which I was able to test it on.
88   2) The ability to drag and drop torrent files into the app has been
89      added.
90   3) It will minimize to the tray instead of task bar and hovering
91      mouse for the tray icon displays the current up and down rate.
92   4) Where previously the various limits boxes didn't validate
93      properly now they do and any invalid input is interpreted as no
94      limit and a nice infinity symbol is displayed.
95   5) Individual torrent info is saved and loaded when the program is
96      closed and reopened allowing torrent limits to be remembered.
97   6) If the program has to wait after the user clicking close for any
98      active connections to shutdown down 'cleanly' an optional small
99      dialog is displayed to alert the user that the program is still
100      running.
101
102Subversion: svn://svn.geekisp.com/halite
103
104In addition you can check out the Trac site (trac.geekisp.com/halite)
105but I haven't really done much with it ... yet.
106
107Thanks:
108
109It can be hard to remember to thank everyone but that is no excuse for
110leaving someone out. If I have done so let me know.
111
112  + Arvid Norberg- As the author of libtorrent he has made the single
113    biggest contribution to this project.
114    http://www.rasterbar.com/products/libtorrent/index.html
115
116  + Christopher Kohloff- The man behind Boost.ASIO a crucial element
117    of libtorrent and my own libhttp library.
118    http://asio.sourceforge.net/
119
120  + nudone (Nick Pearson)- The excellent artist who designed the icon
121    for Halite.
122        wtfcody.com / nudsville.com
123
124  + Austin- Very kindly made the Iss install script for Halite.
125
126  + Everyone who has been in touch with me through email or the forum
127    and have shared their ideas and feature requests for the client.
128    They have given the project direction and purpose.
129
Note: See TracBrowser for help on using the repository browser.