From 63b24c225b53b8e4df0758b86a53babafbade78f Mon Sep 17 00:00:00 2001 From: Nick Gammon Date: Fri, 20 Jun 2014 07:51:45 +1000 Subject: [PATCH] Improvements to documentation --- readme.md | 36 ++++++++++++++++++++---------------- 1 file changed, 20 insertions(+), 16 deletions(-) diff --git a/readme.md b/readme.md index b6b0ddc0..a577920d 100644 --- a/readme.md +++ b/readme.md @@ -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 - +* png - +* sqlite - +* zlib - -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 ------ @@ -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") + \ No newline at end of file