[dasher] Fixing build error due to not having a README file so that we can replace README file with README.md



commit f3bfec2fcf3695bee0e881b640d8ebaabfa62b54
Author: Enes Çakır <24372126+mortheria users noreply github com>
Date:   Fri Mar 23 02:58:55 2018 +0300

    Fixing build error due to not having a README file so that we can replace README file with README.md file 
(#143)
    
    * Setting up config file for Travis.
    
    * Trigger travis
    
    * Updated travis config.
    
    * Added required packages for autogen.sh to Travis config.
    
    * Updated travis config.
    
    * Updated configuration file and travis config.
    
    * Updated config files.
    
    * Updated configure.ac
    
    * Trying to fix AC_INIT bug
    
    * Updated compiler version.
    
    * Added sudo to make install.
    
    * Removed unnecessary package installs.
    
    * Added new readme.md
    
    * Update README.md
    
    * Update .travis.yml
    
    Add a newline at the end
    
    * Removed duplicate readme and updated automake option.
    
    * Updated Automake options.

 README       | 107 --------------------------------------------------------
 README.md    | 112 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++--
 configure.ac |   2 +-
 3 files changed, 110 insertions(+), 111 deletions(-)
---
diff --git a/README.md b/README.md
index e3d034b5..1940cc67 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,117 @@
 ## Build Status:
+
 Linux:
 [![Build 
Status](https://travis-ci.org/dasher-project/dasher.svg?branch=master)](https://travis-ci.org/dasher-project/dasher)
-
+\-
 Java:
 [![CircleCI Build 
Status](https://circleci.com/gh/dasher-project/dasher.svg?style=shield)](https://circleci.com/gh/dasher-project/dasher)
 
-## Information
+## Dasher Version 4.11
+
+Dasher is a zooming predictive text entry system, designed for situations
+where keyboard input is impractical (for instance, accessibility or PDAs). It
+is usable with highly limited amounts of physical input while still allowing
+high rates of text entry.
+
+Dasher is Free software released under the GPL. Further documentation
+may be found in the Doc/ subdirectory
+
+## Requirements
+
+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):
+
+General:
+
+* The Expat XML parser (required)
+
+Linux (see INSTALL.Linux for build time requirements):
+
+* GTK+ (2.6 or greater) (required)
+* GNOME (optional, but highly recommended)
+* Libcanna (optional, for Hiragana to Kanji conversion)
+
+MS Windows:
+
+* MS Speech API (optional)
+* MS Table API (optional - required for tablet start/stop mode)
+
+MS Windows CE:
+
+* (not sure - if anyone knows then please fill this in)
+
+## Platform Specific Notes
+
+* Solaris: Dasher has been tested on Solaris 10. You will need to
+  upgrade to gnome-doc-utils 0.3.2 to install the documentation, which
+  in turn will require libxml 2.6.12 and libxslt 1.1.8. These packages
+  are not required to run dasher once it is built.
+
+There have been some issues with the gthread-2.0 pkgconfig file
+including compiler flags which are not understood by the compiler. You
+may need to shadow this file in another directory with these flags
+removed.
+
+GNU make (gmake) must be used if building gnome documentation.
+
+* Darwin / OS-X: The native UI in the macos directory is badly out of
+  date and will almost definitely require considerable effort to
+  build. We do not currently have the resources to maintain this port,
+  but if you are interested in contributing then let us know
+  (dasher inf phy cam ac uk). The GTK2 front end should build on Darwin
+  with minimal changes, and with a recent enough version of GTK will not
+  require the X11 server.
+
+## Installation Instructions
+
+Please see the file INSTALL.<platform> for details on how to build and
+install Dasher from source on your host system.
+
+## Font Support
+
+Dasher includes some alphabets which require fonts that you probably don't
+have installed; for example, for the International Phonetic Alphabet, Korean
+and Hiragana (Japanese). We aren't legally allowed to distribute a font for
+the IPA, but you can download one yourself from:
+
+http://www.sil.org/computing/fonts/encore-ipa.html
+
+## Kanji Entry
+
+As of Dasher 3.99.0, experimental support for Japanese Kanji entry
+by Hiragana conversion. To build Dasher with this enabled on Linux,
+you need the libcanna conversion library. You also need to be able to
+access a canna conversion server, which can be on the local machine or
+over a network. Please note that Dasher will not start a canna server
+if none is running - you must do so manually before running Dasher.
+Please see the Canna documentation for more details.
+
+Kanji conversion in Microsoft Windows is via the IME API, which is
+part of Windows XP and Asian builds of earlier Windows
+versions. Support for Kanji conversion in Dasher under Windows is
+still very much under development, so please take care when trying
+it out. In particular, Dasher will crash if you try to enable Kanji
+conversion on a machine which does not have Japanese localisation
+installed.
+
+To use Kanji conversion in Dasher, you must select 'Japanese Canna'
+from the 'Alphabet' section of the preferences dialogue, and the
+Japanese language model from the 'Prediction' section.
+
+## Support and Feedback
+
+Please file any bug reports in the GNOME Bugzilla system:
+
+http://bugzilla.gnome.org/
+
+using the 'dasher' package name. We also appreciate general feedback -
+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/
 
-See [README](https://github.com/dasher-project/dasher/blob/master/README) file for more information.
+Thank you for trying Dasher,
 
+The Dasher Team
diff --git a/configure.ac b/configure.ac
index 8382fc92..403b3199 100644
--- a/configure.ac
+++ b/configure.ac
@@ -18,7 +18,7 @@ AC_CONFIG_AUX_DIR([build-aux])
 AC_CONFIG_MACRO_DIR([m4])
 AC_CONFIG_LIBOBJ_DIR([Src/Common])
 
-AM_INIT_AUTOMAKE([1.8 gnu check-news dist-bzip2 subdir-objects])
+AM_INIT_AUTOMAKE([1.8 foreign check-news dist-bzip2 subdir-objects])
 AM_MAINTAINER_MODE
 
 LT_INIT([disable-static])


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