---
inclusion: auto
---

# Project

## Normative Language

- **SHALL**: mandatory.
- **SHOULD**: expected unless there is a documented reason not to.
- **MAY**: optional.
- **MUST NOT**: prohibited.

## Scope

- The project SHALL implement a lightweight, mobile-friendly
  alternative to the cgit software.

## Repository

The public code repo is hosted at <https://git.mlnp.fr/ogit>.

## Repository Map

- `README.org` — describes the overall architecture.
- `bin/` — contains the main ogit executable target.
- `lib/` — contains libraries used by ogit.
  - `lib/syntax.ml` — language detection from filename, shebang,
    modeline.
  - `lib/highlight_grammars.ml` — TextMate grammar registry (48
    languages).
  - `lib/highlight.ml` — tokenisation engine producing dream-html
    spans.
  - `lib/grammars/` — bundled TextMate grammar JSON files (embedded
    via ocaml-crunch).
  - `lib/static/` — CSS and static assets (embedded via ocaml-crunch).
  - `lib/views/` — page rendering modules (ui, components, layout,
    repo, root, error).
- `test/` — contains tests.