README.md 961 Bytes
Newer Older
1 2
# Rosie Pattern Language Documentation

3 4 5 6 7 8 9
## Contents

- [Rosie Pattern Language Reference](doc/rpl.md)
- [Using Rosie's CLI](#using-the-cli)
- [Using Rosie's REPL](#using-the-repl)
- [Using Rosie API](#using-the-api)
- [Project extras](#project-extras)
10

11 12 13

## Using the CLI

14 15
Some command line [examples](../extra/examples/README.md) are available, and
others can be found in blog posts on the [Rosie home page](https://rosie-lang.org).
16

17 18
See also an [html version](doc/man/rosie.1.html) of the Rosie CLI
[man page](doc/man/rosie.1). 
19 20


21
## Using the REPL
22 23 24

See the [REPL documentation](doc/repl.md).

25

26 27 28 29 30 31
## Using the API

Use Rosie in your own programs!  Until this section is complete, see the
high-level notes [in this section](#api-help) below.

**To be written:**
32
- Available language libraries
33 34 35 36 37 38 39
- Full api documentation


## Project extras
- [Syntax highlighting](extra) for some editors 
- Some interesting [quotes about regex](doc/quotes.txt) and related topics