An open API service indexing awesome lists of open source software.

https://github.com/alternative-intelligence-cp/nitpick-docs

Aria programming guide, language specification, tutorials, and API documentation
https://github.com/alternative-intelligence-cp/nitpick-docs

aria documentation language-reference programming-guide

Last synced: 4 days ago
JSON representation

Aria programming guide, language specification, tutorials, and API documentation

Awesome Lists containing this project

README

          

# aria-docs


Nitpick logo: raccoon holding a magnifying glass

[![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)

> 🚧 **Rebrand in progress:** Nitpick is becoming **Nitpick**. This documentation
> repo still uses Nitpick names while the migration is underway. Existing docs,
> examples, man pages, and history are being preserved; source and file-extension
> renames will happen in later coordinated slices.

Documentation, man pages, and examples for the [Nitpick (Nitpick) programming language](https://github.com/alternative-intelligence-cp/nitpick) (v0.36.7).

## Contents

- **guide/** — Programming guide: types, Result handling, Design by Contract, functions, control flow, memory, modules, advanced features, standard library
- **guide/npkpkg.md** — Package manager usage guide
- **man/** — Man page sources and build scripts (`man npkc`, `man npkpkg`, etc.)
- **examples/** — Example programs demonstrating Nitpick features (69 .npk files)
- **reference/** — Language reference and compiler architecture documentation
- **specs/** — Language specification (`aria_specs.txt` — 7,200-line spec covering the 3-layer safety system)
- **packages/** — Package-specific guides (raylib, GML, Tetris, OpenGL)

## Installation

See **[INSTALL.md](https://github.com/alternative-intelligence-cp/aria/blob/main/INSTALL.md)** in the main aria repo for all installation methods (install script, .deb, .rpm, build from source).

## Getting Started

See [GETTING_STARTED.md](GETTING_STARTED.md) for setup instructions.

## Man Pages

```bash
cd man/
make # Build man pages
sudo make install # Install to /usr/share/man/
```

## Examples

Each example can be compiled with:
```bash
npkc examples/.npk -o
./
```

Some examples have subdirectories with their own build scripts.

## License

AGPL-3.0 — see [LICENSE.md](LICENSE.md)