doc: Cleanup of documentation

README.md

@@ -1,13 +1,18 @@
 ECAL
 ====
+
+<p align="center">
+  <img height="150px" style="height:150px;" src="ecal-support/images/logo.png">
+</p>
+
 ECAL is an ECA (Event Condition Action) language for concurrent event processing. ECAL can define event-based systems using rules which are triggered by events. ECAL is intended to be embedded into other software to provide an easy to use scripting language which can react to external events.
 
 Features
 --------
 - Simple intuitive syntax
-- Minimalistic base language
+- Minimalistic base language (by default only writing to a log is supported)
 - Language can be easily extended either by auto generating bridge adapters to Go functions or by adding custom function into the stdlib
-- External events can be easily pushed into the interpreter and scripts written in ECAL can react to the events.
+- External events can be easily pushed into the interpreter and scripts written in ECAL can react to these events.
 - Simple but powerful concurrent event-based processing supporting priorities and scoping for control flow.
 - Handling event rules can match on event state and rules can suppress each other.
 
@@ -66,10 +71,13 @@ $ sh run.sh
 2000/01/01 12:12:02 fib(20) = 6765
 ```
 
+The interpreter can be run in debug mode which adds debug commands to the console. Run the ECAL program in debug mode with: `sh debug.sh` - this will also start a debug server which external development environments can connect to. There is a [VSCode integration](ecal-support/README.md) available which allows debugging via a graphical interface.
+
 ### Further Reading:
 
 - [ECA Language](ecal.md)
 - [ECA Engine](engine.md)
+- [VSCode integration](ecal-support/README.md)
 
 License
 -------

ecal-support/README.md

@@ -20,7 +20,7 @@ The extention can be installed using a precompiled VSIX file which can be downlo
 
 https://devt.de/krotik/ecal/releases
 
-Alternatively you can build the extension yourself. To build the extension you need `npm` installed. Download the source code from the [repository](https://devt.de/krotik/ecal). First install all required dependencies with `npm -i`. Then compile and package the extension with `npm run compile` and `npm run package`. The folder should now contain a VSIX file.
+Alternatively you can build the extension yourself. To build the extension you need `npm` installed. Download the source code from the [repository](https://devt.de/krotik/ecal). First install all required dependencies with `npm i`. Then compile and package the extension with `npm run compile` and `npm run package`. The folder should now contain a VSIX file.
 
 ## Using the extension
 

examples/taylor/.vscode/launch.json

@@ -1,18 +0,0 @@
-{
-    // Use IntelliSense to learn about possible attributes.
-    // Hover to view descriptions of existing attributes.
-    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
-    "version": "0.2.0",
-    "configurations": [
-        {
-            "type": "ecaldebug",
-            "request": "launch",
-            "name": "Debug ECAL script with ECAL Debug Server",
-            "host": "localhost",
-            "port": 33274,
-            "dir": "${workspaceFolder}",
-            "executeOnEntry": true,
-            "trace": false
-        }
-    ]
-}

examples/taylor/debug.sh

@@ -1,2 +0,0 @@
-#!/bin/sh
-../../ecal debug -server main.ecal

examples/taylor/main.ecal

@@ -1,32 +0,0 @@
-m := {
-  "xx" : 1,
-  "ll" : [1, 2, {
-    "tt" : 99
-  }]
-}
-a := 1
-
-func fa() {
-  x := 2
-  a := 3
-  fb()
-  x := 1
-}
-
-func fb() {
-  a := 4
-  fc()
-  a := 10
-}
-
-func fc() {
-  a := 5
-  log(a)
-  y := 1
-  y := 2
-  y := 3
-}
-
-a := 2
-fa()
-a := 999