source: Readme.txt @ 272

Revision 272, 5.7 KB checked in by Eoin, 12 years ago (diff)

Config UI streched.

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