Navigation Menu

Skip to content

Commit

Permalink
Improvements to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
nickgammon committed Jun 19, 2014
1 parent 2b6fb86 commit 63b24c2
Showing 1 changed file with 20 additions and 16 deletions.
36 changes: 20 additions & 16 deletions readme.md
Expand Up @@ -13,14 +13,14 @@ To compile

Certain directories only have skeleton files. These are because the "real" files are in separate libraries which you can download for yourself.

These are:
These libraries are (along with their home pages):

* pcre
* png
* sqlite
* zlib
* pcre - <http://www.pcre.org/>
* png - <http://www.libpng.org/pub/png/libpng.html>
* sqlite - <http://www.sqlite.org/>
* zlib - <http://www.zlib.net/>

In each of those folders is a readme.txt file which explains where to get the relevant libraries, and any minor adjustments needed to make them work with MUSHclient.
In each of those folders is a **readme.txt** file which explains where to get the relevant libraries, and any minor adjustments needed to make them work with MUSHclient.

To run
------
Expand All @@ -31,19 +31,23 @@ They are not part of the source distribution because they are not, strictly spea

These files should be copied into the place where MUSHclient.exe was put by the compiler. In my case this would be the WinRel or WinDebug directories.

* Files

*Files*
* lua5.1.dll - for Lua scripting
* mushclient.hlp - help file
* mushclient.cnt - help table of contents
* tips.txt - tips shown at startup
* spellchecker.lua - Lua file that does the spell checking (loaded at startup)

* lua5.1.dll - for Lua scripting
* mushclient.hlp - help file
* mushclient.cnt - help table of contents
* tips.txt - tips shown at startup
* spellchecker.lua - Lua file that does the spell checking (loaded at startup)
* Directories

* **locale** directory (this has the resources file en.dll which contains menus, dialogs etc.)
* **spell** directory (so the spell checker can find its dictionaries)
* **lua** directory (if you are planning to use any Lua modules like "tprint")

Resources
---------

*Directories*
The resources used by MUSHclient are in the file en.dll (which resides in the directory "locale" mentioned above). To rebuild file you need to download the project mushclient_resources which is on GitHub:

* **locale** directory (this has the resources (menus, dialogs etc.) )
* **spell** directory (so the spell checker can find its dictionaries)
* **lua** directory (if you are planning to use any Lua modules like "tprint")
<https://github.com/nickgammon/mushclient_resources>

0 comments on commit 63b24c2

Please sign in to comment.