Commit 5fbf0aad authored by Jamie A. Jennings's avatar Jamie A. Jennings

Added note on repo organization, and link to new librosie doc

parent 1a2677d0
Pipeline #52032844 passed with stage
in 1 minute and 12 seconds
...@@ -87,10 +87,21 @@ place it in double quotes, like string literals in other programs.) ...@@ -87,10 +87,21 @@ place it in double quotes, like string literals in other programs.)
## Installing ## Installing
- [x] Build from source (see [local installation](#local-installation) below) - [x] Build from source (see [local installation](#local-installation) below)
- [X] [Brew installer for Mac OS X](https://gitlab.com/rosie-community/packages/homebrew-rosie) - [X] [Brew installer for Mac OS X](https://gitlab.com/rosie-community/packages/homebrew-rosie)
- [ ] RPM and debian packages - [ ] RPM and debian packages
### Repository organization
Releases are tagged, e.g. `v1.1.0`. The head of the master branch is always the
latest release plus any post-release documentation updates (which will be folded
into the next release).
The dev branch should be a stable working development build, possibly with some
quirks and likely with out-of-date documentation. If you are a contributor, you
probably want to be running the latest dev branch.
### Build dependencies ### Build dependencies
Tools: git, make, gcc/cc <br> Tools: git, make, gcc/cc <br>
......
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
## Language Reference ## Language Reference
The [Rosie Pattern Language Reference](doc/rpl.md) defines the pattern language The [Rosie Pattern Language Reference](rpl.md) defines the pattern language
apart from the Rosie implementation. apart from the Rosie implementation.
...@@ -11,8 +11,8 @@ apart from the Rosie implementation. ...@@ -11,8 +11,8 @@ apart from the Rosie implementation.
Some command line [examples](../extra/examples/README.md) are available, and 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). others can be found in blog posts on the [Rosie home page](https://rosie-lang.org).
See also an [html version](doc/man/rosie.1.html) of the Rosie CLI See also an [html version](man/rosie.1.html) of the Rosie CLI
[man page](doc/man/rosie.1). [man page](man/rosie.1).
## Using the REPL ## Using the REPL
...@@ -22,16 +22,18 @@ See the [REPL documentation](doc/repl.md). ...@@ -22,16 +22,18 @@ See the [REPL documentation](doc/repl.md).
## Using the API ## Using the API
Use Rosie in your own programs! Until this section is complete, see the Use Rosie in your own programs!
high-level notes [in this section](#api-help) below.
**Forthcoming** 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.
- Available language libraries If you are writing a language binding, or improving one, see the
- Full api documentation [**librosie** API documentation](librosie.md).
## Project extras ## Project extras
- [Syntax highlighting](../extra) for some editors - [Syntax highlighting](../extra) for some editors
- Sample [docker files](../extra/docker) for various distros.
- Some interesting [quotes about regex](quotes.txt) and related topics - Some interesting [quotes about regex](quotes.txt) and related topics
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment