[dasher] Change format, name, location and update content of macOS README (#177)



commit ee26d8adebd3fbb84a6c95bd9735ba6c58231e3c
Author: sebwills <sw sebwills com>
Date:   Mon Apr 20 01:47:25 2020 +0100

    Change format, name, location and update content of macOS README (#177)

 README.md              |  8 +++++---
 README_macOS.md        | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++
 Src/MacOSX/Readme.html | 43 -------------------------------------------
 3 files changed, 55 insertions(+), 46 deletions(-)
---
diff --git a/README.md b/README.md
index 8dd1f3a4..0d7635e0 100644
--- a/README.md
+++ b/README.md
@@ -25,7 +25,7 @@ may be found in the Doc/ subdirectory
 
 Dasher makes use of the following third party software (note that this
 list is potentially inaccurate or incomplete - please send any
-corrections to 'dasherteam yahoogroups com):
+corrections to dasherteam yahoogroups com):
 
 General:
 
@@ -63,6 +63,8 @@ GNU make (gmake) must be used if building gnome documentation.
 
 ### macOS
 
+The macOS version has [its own README](README_macOS.md).
+
 The native UI in the MacOSX directory builds in Xcode 11.3
 and has been tested on macOS 10.14.
 
@@ -72,7 +74,7 @@ require the X11 server.
 
 ## Installation Instructions
 
-Please see the file INSTALL.<platform> for details on how to build and
+Please see the file INSTALL.[platform] for details on how to build and
 install Dasher from source on your host system.
 
 ## Font Support
@@ -117,7 +119,7 @@ please send any comments to 'dasher inf phy cam ac uk'.
 
 You can find the Dasher website at:
 
-http://www.inference.phy.cam.ac.uk/dasher/
+http://www.inference.org.uk/dasher/
 
 Thank you for trying Dasher,
 
diff --git a/README_macOS.md b/README_macOS.md
new file mode 100644
index 00000000..21ef232f
--- /dev/null
+++ b/README_macOS.md
@@ -0,0 +1,50 @@
+# Dasher 5 for macOS
+
+The macOS build of Dasher has been updated (April 2020) to build in 64-bit and run on modern versions of 
macOS (e.g. Catalina). These changes were sponsored by Jorge Tendeiro (http://socraticlife.com.au).
+
+## Using Dasher for macOS
+
+**WARNING: Dasher for macOS is beta quality software. This means it may not always do what it is supposed to 
do. In fact, it could mess up files you choose to edit with it.**
+
+**You should play around a bit with Dasher on inconsequential files to learn the best way to use it; 
remember to save often and make backup files.**
+
+### Basic operation of Dasher
+
+An explanation of how to use the Dasher panel is [here](http://www.inference.org.uk/dasher/Novice.html).
+
+### Direct Mode
+
+Direct Mode can be toggled on and off on the Dasher menu.
+
+If Direct Mode is off, text is written into the edit box at the top of the Dasher window.
+
+If Direct Mode is on, select the target application to send text to using the dropdown at the top of the 
Dasher window.
+
+For Direct Mode to work, you must grant both Dasher and the target application permission to use 
Accessibility features in macOS. You should be prompted to do this when you first enable Direct Mode. If you 
need to do it later, visit System Preferences → Security and Privacy → Accessibility.
+
+### Other features and controls
+
+Please explore Dasher → Preferences to see the many other settings that can be changed.
+
+Of particular note are:
+
+*   Language pane - to choose the language you write in
+*   Control pane - options for how to control zooming in Dasher
+*   Application pane - options for speech generation, and to enable Control Mode. Control mode introduces a 
special box that appears at the end of the alphabet, that allows certain editing and control operations to be 
done from within the Dasher interface
+
+## Training texts
+
+Dasher requires a large amount of sample 'training text' to make efficient predictions. Standard training 
texts are included for some, but not all, of the alphabets/languages available. Training texts for other 
alphabets/languages are available on the Dasher website at http://inference.org.uk/dasher/Download.html .  To 
install a training text, place the text file in your `~/Library/Application Support/Dasher` folder.
+
+Dasher will learn your own writing style, by adding everything you write in Dasher to a training text file 
in `~/Library/Application Support/Dasher`. You can tune Dasher to your own writing style and vocabulary by 
adding a large sample of your own writing to the file that Dasher creates in this folder for the alphabet you 
are using.
+
+## Further information
+
+Please visit our [website](http://www.inference.phy.cam.ac.uk/dasher/) for more information on Dasher.
+
+To report bugs or make a contribution to Dasher development, please visit Dasher project github page at 
https://github.com/dasher-project/dasher
+
+
+Yours,
+
+The Dasher Team
\ No newline at end of file


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]