Merge branch 'master' of https://github.com/bwilcox-1234/ChatScript

Author: chatscriptnlp

BINARIES/MacChatScript

@@ -13,10 +13,12 @@ topic: ~food []
 
 #! I like spinach
 s: ( I like spinach ) Are you a fan of the Popeye cartoons?
-	a: ( yes )  I used to watch him as a child. Did you lust after Olive Oyl?
-    	    b: ( no ) Me neither. She was too skinny.
-    		b: ( yes ) You probably like skinny models.
-	a: ( no ) What cartoons do you watch?
+	
+	a: ( ~yes )  I used to watch him as a child. Did you lust after Olive Oyl?
+    	    b: ( ~no ) Me neither. She was too skinny.
+    	    b: ( yes ) You probably like skinny models.
+	
+	a: ( ~no ) What cartoons do you watch?
      		b: ( none ) You lead a deprived life.
      		b: ( Mickey Mouse ) The Disney icon.
 
@@ -27,19 +29,19 @@ u: ( ![ not never rarely ] I * ~ingest * ~meat ) You eat meat.
 u: ( !~negativeWords I * ~like * ~meat ) You like meat.
 
 #! do you eat bacon?
-?: (do you eat _ [ ham eggs bacon]) I eat '_0
+?: ( do you eat _ [ ham eggs bacon] ) I eat '_0
 
 #! do you like eggs or sushi?
-?: (do you like _* or _*) I don't like '_0 so I guess that means I prefer '_1.
+?: ( do you like _* or _* ) I don't like '_0 so I guess that means I prefer '_1.
 
 #! I adore kiwi.
 s: ( ~like ~fruit ![~animal _bear] )  Vegan, you too...
 
 #! do you eat steak?
-?: (do you eat _~meat) No, I hate _0.
+?: ( do you eat _~meat ) No, I hate _0.
 
 #! I eat fish.
-s: ( I eat _*1 >) 
+s: ( I eat _*1 > ) 
   $food = '_0 
   I eat oysters.
 ```
@@ -58,9 +60,9 @@ Above example mentioned in article [How to build your first chatbot using ChatSc
 * Planner capabilities allow a bot to act in real/virtual worlds.
 * Remembers user interactions across conversations.
 * Document mode allows you to scan documents for content.
-* Ability to control local machines via popen.
+* Ability to control local machines via popen/tcpopen/jsonopen.
 * Ability to read structured JSON data from websites.
-* Postgres and Mongo support for big data or large-user-volume chatbots.
+* [Postgres](https://www.postgresql.org/) and [Mongo](https://www.mongodb.com/) databases support for big data or large-user-volume chatbots.
 
 ## OS Features
 
@@ -73,82 +75,120 @@ Above example mentioned in article [How to build your first chatbot using ChatSc
 * Mature technology in use by various parties around the world.
 * Integrated tools to support maintaining and testing large systems.
 * UTF8 support allows scripts written in any language
-* User support forum on [Chatbots.org](https://www.chatbots.org/ai_zone/viewforum/44/) and [here](https://github.com/bwilcox-1234/ChatScript/issues)
+* User support forum on [chatbots.org](https://www.chatbots.org/ai_zone/viewforum/44/) 
+* Issues or bugs on this [repo](https://github.com/bwilcox-1234/ChatScript/issues)
 
 
 # Getting started
+
 ## Installation
 
 Take this project and put it into some directory on your machine (typically we call the directory ChatScript, but you can name it whatever). That takes care of installation.
 
+    git clone https://github.com/bwilcox-1234/ChatScript
+
+
+## Standalone mode - run locally on a console (for developement/test)
+
+From your ChatScript home directory, go to the BINARIES directory: 
+```bash
+cd BINARIES
 ```
-git clone https://github.com/bwilcox-1234/ChatScript
-```
+And run the ChatScript engine
 
-## How to run locally on a console (for developement/test)
 ### Windows
-Go to the BINARIES directory and type `ChatScript`: 
-```
-cd BINARIES && ChatScript
+```bash
+ChatScript
 ```
 
 ### Linux
+```bash
+./LinuxChatScript64 local
 ```
-cd BINARIES && ./LinuxChatScript64 local
-```
+Note: to set the file executable: `chmod a+x ./LinuxChatScript64`
 
 ### MacOS
-```
-cd BINARIES && ./MacChatScript local
+```bash
+./MacChatScript local
 ```
 
-This will cause ChatScript to load and ask you for a username. Enter whatever you want. You are then talking to the default demo bot `Harry`.
+This will cause ChatScript to load and ask you for a username. Enter whatever you want. 
+You are then talking to the default demo bot `Harry`.
 
-## How to run as a server (for production)
-### Windows
-Go to the BINARIES directory and type `ChatScript port=1024`
-```
-cd BINARIES && ChatScript port=1024
+## Server Mode (for production)
+From your ChatScript home directory, go to the BINARIES directory and run the ChatScript engine as server
+### Run the server on Windows
+```bash
+ChatScript port=1024
 ```
-### Linux
+### Run the server on Linux
+```bash
+./LinuxChatScript64
 ```
-cd BINARIES && ./LinuxChatScript64
+### Run the server on MacOS
+```bash
+./MacChatScript
 ```
-### MacOS
+
+This will cause ChatScript to load as a server.  
+But you also need a client (to test client-server communication). 
+You can run a separate command window and go to the BINARIES directory and type 
+
+### Run a client (test) on Windows
+```bash
+ChatScript client=localhost:1024 
 ```
-cd BINARIES && ./MacChatScript
+
+### Run a client (test) on Linux
+```bash
+./LinuxChatScript64 client=localhost:1024
 ```
 
-This will cause ChatScript to load as a server. 
-But you also need a client (to test client-server communication). You can run a separate command window and go to the BINARIES directory and type `ChatScript client=localhost:1024` if you are on Windows, or type `./LinuxChatScript64 client=localhost:1024` if you are on Linux. This will cause ChatScript to load as a client and you can talk to the server. 
+### Run a client (test) on MacOS
+```bash
+./MacChatScript client=localhost:1024
+```
 
-## How to build the engine.
-On windows if you have Visual Studio installed, launch `VS2010/chatscript.sln` or `VS2015/chatscript.sln` and do a build. The result will go in the `BINARIES` directory.
+This will cause ChatScript to load as a client and you can talk to the server. 
 
-On Linux, go stand in the SRC directory and type `make server` (assuming you have make and g++ installed). This creates BINARIES/ChatScript, which can run as a server or locally. There are other make choices for installing PostGres or Mongo.
 
 ## How to build a bot
 Run ChatScript locally. From the ChatScript command prompt, type 
-```
-:build Harry
-```
 
-or whatever other preinstalled bot exists. If you have revised basic data, you can first do `:build 0` .
+    :build Harry
+
+or whatever other preinstalled bot exists. If you have revised basic data, you can first:
+
+    :build 0
+
+## How to compile the engine.
+On windows if you have Visual Studio installed, launch `VS2010/chatscript.sln` or `VS2015/chatscript.sln` and do a build. 
+The result will go in the `BINARIES` directory.
+
+On Linux, go stand in the SRC directory and type `make server` (assuming you have make and g++ installed). This creates BINARIES/ChatScript, which can run as a server or locally. There are other make choices for installing PostGres or Mongo.
+
 
 # Full Documentation
+
 [ChatScript Wiki (user guides, tutorials, papers)](/WIKI/README.md)
 
+
 # Contributing
+
 1. Fork it
 2. Create your feature branch (git checkout -b my-new-feature)
 3. Commit your changes (git commit -am 'Add some feature')
 4. Push to the branch (git push origin my-new-feature)
 5. Create new Pull Request
 
+
 # Last releases
+
 [changes.md](/changes.md)
 
+
 # Author 
+
 * Bruce Wilcox
   * home website: [BrilligUnderstanding.com](http://www.brilligunderstanding.com)
   * mail:  [[email protected]](mailto:[email protected] )  

NON-WINDOWS NON-C/XCODE/MacChatScript.xcodeproj/WorkspaceSettings.xcsettings

@@ -0,0 +1,27 @@
+# Editors Syntax Highlight for Chatscript 
+
+## Sublime Text editor
+
+  [Sublime Text](https://www.sublimetext.com/) is a sophisticated text editor for code, markup and prose. 
+
+  There is a Sublime Text syntax hightlight plugin for ChatScript. To install: 
+
+  [ChatScript package control plugin](https://packagecontrol.io/packages/ChatScript%20Syntax)
+
+  See also [Chatscript-tmlanguage github project](https://github.com/kuzyn/chatscript-tmlanguage), thanks [Samuel Cousin](https://github.com/kuzyn)!
+
+## Vim editor
+
+  [Vim](http://www.vim.org/) is probably the most used editor ever (from CLI in \*nix OSs). To install:
+
+  [ChatScript.vim](https://github.com/solyaris/ChatScript.vim)
+
+
+# Client-server ChatScript integrations
+
+## rChatScript
+
+  https://github.com/solyaris/rChatScript
+
+It's a very basic ChatScript client Ruby gem, managing OOB messages. Contains an [example](https://github.com/solyaris/rChatScript/tree/master/examples/telegram) of ChatScript integration with [Telegram](www.telegram.org) instant messaging chat app.
+