================================================================================
== README - HalonaTools. =======================================================
================================================================================

 Contents:
 
 - Project Description.
 - Project Structure.
 - Coding Conventions.
 - Project Life-Cycle Management (PLM).
 - Known Issues.
 - TODO List.
 - Terms of Use.

================================================================================
== Project Description. ========================================================
================================================================================

 HalonaTools is a WoW Addon for primarily created for use by guild leaders and
 those charged with operational responsibility for guilds.
 
 It is written in the Lua language and targeted towards the WoW implementation
 of Lua and is also dependent upon the Ace3 and LibDataBroker libraries.
 
 More complete details of the addon's functionality is provided at the WoWAce
 website on the addon's wiki page, linked below.
 
 http://www.abc.com/xyz
 
================================================================================
== Project Structure. ==========================================================
================================================================================

 This project's source-code is arranged firstly in accordance with the
 specification of the WoW Addons standards and secondly by the established
 practices and standards of the WoW Addons community.
 
 From the project root ("{PR}") folder, code is therefore arranged as follows:
 
 {PR}/HalonaTools.toc                    Table of Contents, required by WoW.
 {PR}/HalonaTools.lua                    Main Lua resource.
 {PR}/Changelog.txt                      Simple text file, log of changes made.
 {PR}/Localisation/enUS.lua              I18N file for US English.
 {PR}/Components/HT*.lua                 Additional HalonaTools modules.
 {PR}/Libs/LibDataBroker-1.1             Hard-copy of the LDB library resource.
 
================================================================================
== Coding Conventions. =========================================================
================================================================================

 The Lua code-base is formatted, commented and structured for clarity of reading
 by any maintainer.

================================================================================
== Project Lifecycle Management (PLM). =========================================
================================================================================

 The authoritative source for this addon project is maintained in a Subversion
 repository provided and maintained by the CurseForge service. Access to the
 source-code is provided to developers via the WoWAce portal whilst final
 packaged copies of the project's resulting WoW addon are available exclusively
 via the Curse website and via the Curse Client desktop application.
 
 Developers will typically want to use a packaged copy for development since
 this will contain up-to-date copies of the project's dependencies bundled
 within the distribution.
 
 It is expected that most development or maintainance of this addon will be
 performed on a live server (be it a live realm or a PTR) due to the lack of
 available development environments for such projects.
 
 Thus, once WoW is loaded, changes may be made and picked up by reloading the
 in-game user interface via issuing the following command:
 
 /console reloadui
 
 It is recommended that developers install the BugSack and BugGrabber addons
 to enable easier comprehension of issues that may arise through the
 development process.
 
 Once changes have been accepted they may be commited back to the CurseForge
 SVN repo in the normal manner.
 
================================================================================
== Known Issues / Workarounds. =================================================
================================================================================

 Issues:
 
   There are no known issues at this time.
 
 Workarounds:
 
   There are no known workarounds at this time.

================================================================================
== TODO List. ==================================================================
================================================================================

 There are no outstanding TODO list items at this time.
 
================================================================================
== Terms of Use. ===============================================================
================================================================================

 TBC. This software is copyright and all rights are reserved.

================================================================================
== End of Document. ============================================================
================================================================================
