<div style="text-align:center;padding-top:1rem;">
    <img src="static/img/logo.png" width=200 style="border-radius:1rem">
</div>

## Parser Overview

### About `owens-ml-parser`

This parser for the `owens-ml` markup language is a learning project to make a simple library using `nom`. This "core" parser can then easily be extended to runtimes and bindings in other languages (Python using `pyo3` for example) to make a small ecosystem.

*NOTE: As it is a learning project, it may not be to the best of quality.*

### Planned ecosystem

- Core parser library: **[owens-ml-parser](https://gitlab.com/scOwez/owens-ml-parser)**
- `owens-ml` design spec: **[owens-ml spec](https://gitlab.com/scOwez/owens-ml-parser#markup-language-spec-overview)**
- Python port: **N/A**
- Rust runtime: **N/A**

---

## Markup Language Spec Overview

### About `owens-ml`

`owens-ml` is an easy-to-parse, generalized (can be used in place of json/yaml/toml/similar), implamented with **Rust** + **the `nom` library**.

Some of the key objectives for `owens-ml` are described in the bullet-points below:

- **Easy & efficiant to parse; no infering types.**
- Generalized syntax; cross compatibile with JSON, TOML, YAML or Python Dicts with very small to none changes in layout.
- *Relativly* easy to read; this is not a main priority for this mu language but it is always nice to have.
- ***(Future)*** owens-ml compatibility with serde to allow translations to and from `owens-ml`.

### Example `owens-ml` syntax

```json
(s) "hello there" (o) {
    (s) "woo" (a-i) [
        4234,
        5,
        34
    ],
    (i) 3423 (o) {
        (s) "ids" (o) {
            (i) 423 (s) "scOwez",
            (i) 4234 (s) "gdude",
            (i) 234 (s) "bisk",
            (s) "username_dynamic" (s) "woo"
        }
    }
},
(s) "cool_array" (a-s) [
    "woo",
    "cool",
    "awesome",
    ":)"
]
```

As you can see, `owens-ml` is a fiercely statically-typed markup language with a different annotation for *every* different type. This has a reason: **parsing ease**.