Skip to content

alternative-intelligence-cp/nitpick-docs

Repository files navigation

nitpick-docs

Nitpick logo: raccoon holding a magnifying glass

License: Apache 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 (v0.64.4).

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 (nitpick_specs.txt — 7,200-line spec covering the 3-layer safety system)
  • packages/ — Package-specific guides (raylib, GML, Tetris, OpenGL)

Installation

See INSTALL.md in the main nitpick repo for all installation methods (install script, .deb, .rpm, build from source).

Getting Started

See GETTING_STARTED.md for setup instructions.

Man Pages

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

Examples

Each example can be compiled with:

npkc examples/<name>.npk -o <name>
./<name>

Some examples have subdirectories with their own build scripts.

License

AGPL-3.0 — see LICENSE.md


Nitpick Ecosystem

This repository is part of the Nitpick ecosystem.

About

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

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors