Skip to content

Commit

Permalink
readme and help
Browse files Browse the repository at this point in the history
  • Loading branch information
jweinst1 committed Jun 19, 2018
1 parent f778557 commit 218108b
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 2 deletions.
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Wind

[![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](https://github.com/jweinst1/Wind/blob/master/LICENSE.md)

The Flow-based Programming Language

## Intro
Expand All @@ -17,6 +19,16 @@ wind> out
[ 77 44 ]
```

It can also seamlessly reduce and transform data

```
wind> push 5 5 5 -> out
[ 5 5 5 ]
wind> map ** 4 | - 1 -> reduce +
wind> out
[ 1872 ]
```

To optimize both speed and memory usage, `Wind` does not use dynamic memory allocation. It relies on static memory. The advantages of this is to allow the amount of memory Wind uses to be highly customizable at compile time, and to make `Wind` a truly scalable language, one that fits in embedded systems, or much larger, heavy systems.

Wind, although not a *natively* compiled language, also is not a true interpreted language. It does not use it's own byte code instruction set, nor does it form abstract syntax trees from source code. It reads code as data and executes it directly.
Expand Down Expand Up @@ -117,7 +129,11 @@ Wind -t "push 5 3 4 -> reduce + -> out -> push 6 6 6 6 6 6 6 -> reduce + -> out
Time: 0.000081
```

#### `-h`:

The `-h` flag prints the `Wind` help manual to stdout. You can find more detailed guides in the wiki for this repo. A website in the near future will have a full fledged documentation.


## Stage

`Wind` is currently in the alpha development stage, the first release version is still in progress.
`Wind` is currently in the alpha development stage, the first production release version is still in progress. The language format and overall scheme will not change, but many components and values will be added to it in the near future. When an initial release is made, a specification for the language will also be published.
2 changes: 1 addition & 1 deletion include/LangInfo.h
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

#define LangInfo_NAME "Wind"

#define LangInfo_REPL_INS "The Wind Programming Language REPL\nTo exit, simply enter 'exit'.\n"
#define LangInfo_REPL_INS "The Wind Programming Language REPL\nTo exit, simply enter 'exit'. For help, run with '-h' flag.\n"

#define LangInfo_HELP "The Wind Programming Language Help Guide\n \
save command: \n \
Expand Down

0 comments on commit 218108b

Please sign in to comment.