doc

Author: easycoder

README.md

@@ -1,65 +1,58 @@
 # Introduction
-This is the Python version of EasyCoder, a high-level English-like scripting language suited for prototyping and rapid testing of ideas. It operates on the command line.
+This is the Python version of **_EasyCoder_**, a high-level English-like scripting language suited for prototyping and rapid testing of ideas. It operates on the command line.
 
-The JavaScript version of EasyCoder, which provides a full set of graphical features to run in a browser, is at [https://easycoder.github.io](https://easycoder.github.io)
+The JavaScript version of **_EasyCoder_**, which provides a full set of graphical features to run in a browser, is at
+
+Repository: [https://github.com/easycoder/easycoder.github.io](https://github.com/easycoder/easycoder.github.io)
+Website: [https://easycoder.github.io](https://easycoder.github.io)
 
 ## Quick Start
-1: Install EasyCoder in your Python environment:
+Install **_EasyCoder_** in your Python environment:
 ```
 pip install easycoder
 ```
-2: Write a test script, 'hello.ecs':
+Write a test script, 'hello.ecs', containing the following:
 ```
 print `Hello, world!`
 ```
-This is traditionally the first program to be written in virtually any language. To run it, use the following command:
-```
-easycoder hello.ecs
-```
+This is traditionally the first program to be written in virtually any language. To run it, use `easycoder hello.ecs`.
+
 The output will look like this:
+
 ```
+EasyCoder version 5
 Compiled <anon>: 1 lines (2 tokens) in 0 ms
 Run <anon>
 1-> Hello, world!
 ```
-To avoid having to use REPL you can set up a simple executable command such as this Python script. On Linux the first line will ensure it runs as a command if given execute permission. You can name it 'easycoder' - there's no need for a '.py' extension.
-```
-#!/bin/python3
-
-from sys import argv
-from easycoder import Program
-
-if (len(argv) > 1):
-    Program(argv[1:])
-else:
-    print('Syntax: easycoder <scriptname> [plugins]')
-```
-With this you can run your script with the command `easycoder hello.ecs`. You can place `easycoder` anywhere on your system execution path, such as in a local `bin` directory.
-
 It's conventional to add a program title to a script:
+
 ```
 !   Test script
-
     script Test
-
     print `Hello, world!`
 ```
 The first line here is just a comment and has no effect on the running of the script. The second line gives the script a name, which is useful in debugging as it says which script was running. When run, the output is now
+
 ```
+EasyCoder version 5
 Compiled Test: 5 lines (4 tokens) in 0 ms
 Run Test
 5-> Hello, world!
 ```
 As you can guess from the above, the print command gives the line in the script it was called from. This is very useful in tracking down debugging print commands in large scripts.
 
-In the repository is a folder called `tests` containing a couple of sample scripts. `benchmark.ecs` allows the performance of EasyCoder to be compared to other languages if a similar program is written for each one. `tests.ecs` is a test program containing many of the EasyCoder features.
+Here in the repository is a folder called `scripts` containing some sample scripts:
+
+`benchmark.ecs` allows the performance of EasyCoder to be compared to other languages if a similar program is written for each one  
+`tests.ecs` is a test program containing many of the EasyCoder features  
+`fizzbuzz.ecs` is a simple programming challenge often given at job interviews
 
 ## The EasyCoder programming language
 There are three primary components to the language:
- 1 Keywords
- 2 Values
- 3 Conditions
 
-All program lines start with a keyword - a command to EasyCoder to do something
+ - Keywords
+ - Values
+ - Conditions
 
-(Under construction)
+[Keywords](doc/keywords.md)

doc/core/add.md

@@ -0,0 +1,8 @@
+## Syntax:
+`add {value} to {variable}`  
+`add {value} to {value} giving {variable}`
+## Examples:
+`add 1 to N`  
+`add N to Total giving Total`
+## Description:
+Adds a numeric value to a numeric variable or adds two values and puts the result into a variable. See elsewhere in this documentation for an explanation of what is meant by a value. If you add to a variable it must already hold a numeric value, but if you assign a variable to hold the result of an addition it will lose whatever value it previously held. 

doc/core/append.md

@@ -0,0 +1,8 @@
+## Syntax:
+`append {value} to {array}`
+## Examples:
+`put empty into ItemArray`  
+`append `First value` to ItemArray`  
+`append `Second value` to ItemArray`
+## Description:
+Appends an item to a JSON array, which is is a string value held in a single variable element (not to be confused with a multi-element variable). See also [element](element.md).

doc/keywords.md

@@ -0,0 +1,7 @@
+# EasyCoder Keywords
+
+The core package contains all the keywords needed for general programming, and in most cases these all that will be needed.
+
+The core keywords are:
+
+[add](core/add.md) [append](core/append)

scripts/hello.ecs

@@ -0,0 +1 @@
+print `Hello, world!`