README.md 1.14 KB
Newer Older
Jamie A. Jennings's avatar
Jamie A. Jennings committed
1
2
# Rosie Pattern Language Documentation

Jamie A. Jennings's avatar
Jamie A. Jennings committed
3
## Language Reference
4

5
The [Rosie Pattern Language Reference](rpl.md) defines the pattern language
Jamie A. Jennings's avatar
Jamie A. Jennings committed
6
apart from the Rosie implementation.  
Jamie A. Jennings's avatar
Jamie A. Jennings committed
7

Jamie A. Jennings's avatar
Jamie A. Jennings committed
8
9
10
11
12
## Unit tests

Unit tests are written as RPL comments and are described in the
[Unit Test Documentation](unittest.md). 

13
14
15

## Using the CLI

Jamie A. Jennings's avatar
Jamie A. Jennings committed
16
17
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).
18

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


Jamie A. Jennings's avatar
Jamie A. Jennings committed
23
## Using the REPL
24
25
26

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

Jamie A. Jennings's avatar
Jamie A. Jennings committed
27

28
29
## Using the API

30
Use Rosie in your own programs!  
31

32
33
34
If you are looking for language bindings for **librosie**, you'll find them in
the [Rosie Community / Clients](https://gitlab.com/rosie-community/clients)
group.
Jamie A. Jennings's avatar
Jamie A. Jennings committed
35

36
37
If you are writing a language binding, or improving one, see the
[**librosie** API documentation](librosie.md).
38
39
40


## Project extras
Jamie A. Jennings's avatar
Jamie A. Jennings committed
41
- [Syntax highlighting](../extra) for some editors 
42
- Sample [docker files](../extra/docker) for various distros.
Jamie A. Jennings's avatar
Jamie A. Jennings committed
43
- Some interesting [quotes about regex](quotes.txt) and related topics
44