source: trunk/Readme.txt @ 771

Revision 771, 8.0 KB checked in by Eoin, 9 years ago (diff)

Released the snapshot 0.3.1.8

Line 
1Halite: A Free Open-Source BitTorrent client
2
3Version: 0.3.1.8 dev 766 released 10th June 2009
4
5WWW:   http://www.binarynotions.com/halite-bittorrent-client
6Forum: http://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  + 'Managed torrent' queue system.
24  + Disk cache support.
25  + Trackerless torrents (using the Mainline kademlia DHT protocol).
26  + IP filtering with eMule style ipfilter.dat import.
27  + Protocol Encryption support.
28  + Translations of the UI into a number of languages through the help
29    of volunteers. (if you wish to help with a translation then please do)
30  + Minimise to tray with transfer rate summary.
31  + Full Unicode support through UTF-8 and native Windows wide-char
32    strings.
33  + Login support where tracker requires it.
34  + Ability to edit trackers specified in the torrent.
35  + Transfer rate and connection limits both global and per-torrent.
36  + Torrent file creation.
37  + Port randomisation and forwarding (UnPlug and Play or NAT-PMP)
38  + Compatible with UAC.
39  + Shutdown scheduler.
40
41Requirements: Windows 2000, XP, Server 2003, Vista, Server 2008 or Win7.
42
43Important note for people upgrading!
44
45When installing through the MSI file download, Halite will make a
46registry entry pointing it to use the local Application Data directory
47for all configuration files. User should manually copy any existing
48files from an older Halite version to that directory. The recommended
49files and folder to copy are:
50
51Halite.xml
52BitTorrent.xml
53IPFilter.bin
54DHTState.bin
55resume/*
56torrents/*
57
58These changes were necessary to make Halite fully compatible with User
59Account Control. To revert to 'portable mode' whereby all config
60information will be saved alongside the executable simply delete that
61registry key (HKEY_CURRENT_USER\Software\Halite\path). If you only
62ever used the standalone download release this will not be necessary.
63
64Changes:
65
66 + from v 0.3.1 to 0.3.1.8:
67   1) Shutdown Dialog added.
68   2) Updated to libtorrent 0.14.4
69      - Potential libtorrent vulnerability fixed.
70   3) Numerous small bug fixes and improvements.
71
72 + from v 0.3.1 to 0.3.1.6:
73   1) Queue View Fixed
74   2) Sorting fixed.
75   3) libtorrent 0.14 integration finished.
76
77 + from v 0.3.1 to 0.3.1.6:
78   1) Based on libtorrent 0.14 which brings with it:
79      - Disk cache support
80      - 'Managed torrent' queue system
81      - Improved seeding and choking behavior
82      - Resource usage optimizations
83      - Many more fixes and improvements
84   (code.rasterbar.com/libtorrent/browser/tags/libtorrent-0_14/ChangeLog)
85
86   2) Optional port randomizations (both main and DHT).
87   3) Numerous internal settings are now exposed by the GUI.
88   4) Plays nice by Vista/Server 2008 UAC rules. See note above.
89   2) Rewritten XML fileformat (again) with greatly improved robustness.
90
91 + from v 0.3.0.7 to 0.3.1:
92   1) Bug fixes.
93
94 + from v 0.3.0.5 to 0.3.0.7:
95   1) Adds ability to create torrent files.
96   2) A lot of small improvements and bug fixes.
97
98 - from v 0.3.0.2 to 0.3.0.5:
99   1) Right-click context menu option to 'Open download folder'.
100   2) Right-click context menu option to force a file recheck.
101   3) Option to move seeding torrent to another folder.
102   4) Fixed a bug with tracker logins.
103
104 + from v 0.3 to 0.3.0.2:
105   Mainly a bugfix release.
106   1) Fixed a bug with Tray Icon remaining after window was restored.
107   2) Torrent Connection and Transfer setting mapped to incorrect
108      editbox.
109   3) Subtle bug where some settings didn't register straight away.
110
111 + from v 0.2.9 to 0.3:
112   1) File selection and/or priority settings.
113   2) Protocol Encryption.
114   3) New tabbed interface makes better use of screen real estate.
115   4) Updated to recent versions of Boost (1.34.1) and libtorrent.
116   5) Numerous bug fixes.
117   
118 + from v 0.2.8 to 0.2.9:
119   1) Full Unicode support!
120   2) Rewitten XML fileformat with greatly improved robustness.
121   3) New tabbed interface makes better use of screen real estate.
122   4) Ability to edit Trackers and set login details.
123   5) Comprehensive logging for diagnosing problems.
124   6) Windows 2000 and Server 2003 supported fully.
125   7) Switched to MSVC 2005 compiler (8.0) for improved reliability
126      though at the cost of slightly bigger executables.
127   
128+ from v 0.2.7 to 0.2.8:
129   1) IP filtering support eMule style ipfilter.dat files.
130   2) DHT support, thought it is turned off by default.
131   3) Can select alternate save directory for torrents..
132   4) New icon!
133
134 + from v 0.2.6 to 0.2.7:
135   1) By default Halite will only allow one instance to be launched
136   2) Halite can be set as the default program for '.torrent' files.
137   3) ETA indicator for torrents. 4) Minor GUI tweaks.
138
139 + from v 0.2.5 to 0.2.6:
140   1) Fixed a silly bug (i.e. I should have caught it sooner) whereby
141      exiting Halite from the tray would screw up the window layout
142      next time running it.
143   2) Added auto-selection to Torrents list to make it more intuitive.
144
145 + from v 0.2 to 0.2.5:
146   1) The GUI is slightly altered so that it looks consistent and neat
147      for a number of visual styles which I was able to test it on.
148   2) The ability to drag and drop torrent files into the app has been
149      added.
150   3) It will minimise to the tray instead of task bar and hovering
151      mouse for the tray icon displays the current up and down rate.
152   4) Where previously the various limits boxes didn't validate
153      properly now they do and any invalid input is interpreted as no
154      limit and a nice infinity symbol is displayed.
155   5) Individual torrent info is saved and loaded when the program is
156      closed and reopened allowing torrent limits to be remembered.
157   6) If the program has to wait after the user clicking close for any
158      active connections to shutdown down 'cleanly' an optional small
159      dialog is displayed to alert the user that the program is still
160      running.
161
162Subversion: svn://svn.geekisp.com/halite
163
164In addition you can check out the Trac site (trac.geekisp.com/halite)
165but I haven't really done much with it ...yet.
166
167Thanks:
168
169It can be hard to remember to thank everyone but that is no excuse for
170leaving someone out. If I have done so let me know.
171
172  + Arvid Norberg- As the author of libtorrent he has made the single
173    biggest contribution to this project.
174    http://www.rasterbar.com/products/libtorrent/index.html
175
176  + Christopher Kohloff- The man behind Boost.ASIO a crucial element
177    of libtorrent and my own libhttp library.
178    http://asio.sourceforge.net/
179
180  + nudone (Nick Pearson)- The excellent artist who designed the icon
181    for Halite.
182        wtfcody.com / nudsville.com
183
184  + Tw@in 28 for all the help moderating the forum.
185
186  + Austin; very kindly made the Iss install script for Halite.
187
188  + Everyone who has been in touch with me through email or the forum
189    and have shared their ideas and feature requests for the client.
190    They have given the project direction and purpose.
191
192  + And of course all the translators:                   
193
194    - devGod – Nederlandse vertaling.
195    - MaikelChan - maikelchan88@gmail.com - Traducción en Español de España.
196    - Prome – prome.lwaku.info – Avtor slovenskega prevoda.                 
197    - Tw@in 28 – twain_28@hotmail.com - Traduttore Italiano.
198    - u!^DEV  - germanpg.hacker.to - deutsche Übersetzung.
199    - webdr - www.langturk.com - Türkçe çeviri.
200    - Čagalj - cagalj@mail.ru - Preveo sve na srpski (latinicu i ćirilicu).
201    - AlexKrycek - alexkrycek0@gmail.com - μετάφραση στα ελληνικά.
Note: See TracBrowser for help on using the repository browser.