source: trunk/Readme.txt @ 467

Revision 467, 6.5 KB checked in by Eoin, 11 years ago (diff)

Reverting to Boost 1.34.1 for the 0.3.1 release.

Line 
1Halite: A Free Open-Source BitTorrent client
2
3Version: 0.3.0.7 dev 465 released 30th May 2008
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  + 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  + Torrent file creation.
34
35Requirements: Windows 2000, XP, Server 2003 and Vista (Note currently
36Vista users need to install the application to a directory where they
37will have full read and write access to. The recommended solution is
38to use the standalone exe distribution and not the installer.
39
40Known Issues/Problems:
41
42Halite does not always gracefully accept configuration information
43from previous versions. Should you experience crashes upon running
44Halite you should delete any old Halite.ini.xml or Halite.xml.
45
46You will not lose any downloads in progress and those which do not
47restart automatically can be done so manually by loading the
48associated torrent file from the 'torrents' subdirectory.
49
50Changes:
51
52 - from v 0.3.0.5 to 0.3.0.7:
53   1) Adds ability to create torrent files.
54   2) A lot of small improvements and bug fixes.
55
56 - from v 0.3.0.2 to 0.3.0.5:
57   1) Right-click context menu option to 'Open download folder'.
58   2) Right-click context menu option to force a file recheck.
59   3) Option to move seeding torrent to another folder.
60   4) Fixed a bug with tracker logins.
61
62 - from v 0.3 to 0.3.0.2:
63   Mainly a bugfix release.
64   1) Fixed a bug with Tray Icon rmeaining after window was restored.
65   2) Torrent Connection and Transfer setting mapped to incorrect editbox.
66   3) Subtle bug where some settings didn't register straight away.
67
68 - from v 0.2.9 to 0.3:
69   1) File selection and/or priority settings.
70   2) Protocol Encryption.
71   3) New tabbed interface makes better use of screen real estate.
72   4) Updated to recent versions of Boost (1.34.1) and libtorrent.
73   5) Numerous bug fixes.
74   
75 - from v 0.2.8 to 0.2.9:
76   1) Full Unicode support!
77   2) Rewitten XML fileformat with greatly improved robustness.
78   3) New tabbed interface makes better use of screen real estate.
79   4) Ability to edit Trackers and set login details.
80   5) Comprehensive logging for diagnosing problems.
81   6) Windows 2000 and Server 2003 supported fully.
82   7) Switched to MSVC 2005 compiler (8.0) for improved reliability
83      though at the cost of slightly bigger executables.
84   
85- from v 0.2.7 to 0.2.8:
86   1) IP filtering support eMule style ipfilter.dat files.
87   2) DHT support, thought it is turned off by default.
88   3) Can select alternate save directory for torrents..
89   4) New icon!
90
91 - from v 0.2.6 to 0.2.7:
92   1) By default Halite will only allow one instance to be launched
93   2) Halite can be set as the default program for '.torrent' files.
94   3) ETA indicator for torrents. 4) Minor GUI tweaks.
95
96 - from v 0.2.5 to 0.2.6:
97   1) Fixed a silly bug (i.e. I should have caught it sooner) whereby
98      exiting Halite from the tray would screw up the window layout
99      next time running it.
100   2) Added auto-selection to Torrents list to make it more intuitive.
101
102 - from v 0.2 to 0.2.5:
103   1) The GUI is slightly altered so that it looks consistent and neat
104      for a number of visual styles which I was able to test it on.
105   2) The ability to drag and drop torrent files into the app has been
106      added.
107   3) It will minimize to the tray instead of task bar and hovering
108      mouse for the tray icon displays the current up and down rate.
109   4) Where previously the various limits boxes didn't validate
110      properly now they do and any invalid input is interpreted as no
111      limit and a nice infinity symbol is displayed.
112   5) Individual torrent info is saved and loaded when the program is
113      closed and reopened allowing torrent limits to be remembered.
114   6) If the program has to wait after the user clicking close for any
115      active connections to shutdown down 'cleanly' an optional small
116      dialog is displayed to alert the user that the program is still
117      running.
118
119Subversion: svn://svn.geekisp.com/halite
120
121In addition you can check out the Trac site (trac.geekisp.com/halite)
122but I haven't really done much with it ... yet.
123
124Thanks:
125
126It can be hard to remember to thank everyone but that is no excuse for
127leaving someone out. If I have done so let me know.
128
129  + Arvid Norberg- As the author of libtorrent he has made the single
130    biggest contribution to this project.
131    http://www.rasterbar.com/products/libtorrent/index.html
132
133  + Christopher Kohloff- The man behind Boost.ASIO a crucial element
134    of libtorrent and my own libhttp library.
135    http://asio.sourceforge.net/
136
137  + nudone (Nick Pearson)- The excellent artist who designed the icon
138    for Halite.
139        wtfcody.com / nudsville.com
140
141  + Austin- Very kindly made the Iss install script for Halite.
142
143  + Everyone who has been in touch with me through email or the forum
144    and have shared their ideas and feature requests for the client.
145    They have given the project direction and purpose.
146
147  + And of course all the translators:
148    - devGod – Nederlandse vertaling.
149    - MaikelChan - maikelchan88@gmail.com - Traducción en Español de España.
150    - Prome – prome.lwaku.info – Avtor slovenskega prevoda.
151    - Tw@in 28 (Giulio Pascali) – twain_28@hotmail.com - Traduttore Italiano.
152    - u!^DEV  - germanpg.hacker.to - deutsche Übersetzung.
153    - webdr - www.langturk.com - Türkçe çeviri.
154
Note: See TracBrowser for help on using the repository browser.