Skip to content

Commit

Permalink
readme toc
Browse files Browse the repository at this point in the history
  • Loading branch information
jweinst1 committed Jun 19, 2018
1 parent ca74d38 commit 5b1ca1f
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ The Flow-based Programming Language
# Table of Contents

- [Intro](#intro)
- [Installation] (#installation)
- [Guide] (#guide)
- [Syntax] (#syntax)

## Intro

Expand Down Expand Up @@ -137,6 +140,28 @@ Time: 0.000081

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.

## Guide

The following details the language components, features, and syntax.

### Syntax

The `Wind` language uses a continuous, stream-like syntax. It is meant to be read in a linear, straight fashion that emphasizes fixed units of commands and computation.

The general format of `Wind` is the following:

```
(command) (arguments ...) -> (command) (arguments ...)
```

Comments are denoted by bounded semicolons, between `;`, such as

```
push 5 -> ;this is a comment; out
```
where anything between the semicolons is ignored.



## Stage

Expand Down

0 comments on commit 5b1ca1f

Please sign in to comment.