README.md: preparating for TOC autogeneration
This commit is contained in:
parent
fea80a57c7
commit
5e80e1984f
27
README.md
27
README.md
|
@ -1,5 +1,16 @@
|
|||
# hnix
|
||||
|
||||
Haskell parser, evaluator and type checker for the Nix language.
|
||||
|
||||
<!-- TOC generates automatically, do not bother editing any further TOC text -->
|
||||
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
|
||||
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
|
||||
## Contents
|
||||
|
||||
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
|
||||
|
||||
---
|
||||
|
||||
| [![Chat](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/haskell-nix/Lobby) | CI |
|
||||
| :--- | :--- |
|
||||
| [![Hackage](https://img.shields.io/hackage/v/hnix?color=%235e5086&label=Latest%20release)](https://hackage.haskell.org/package/hnix) | [![Hackage, Cabal, Linux](https://github.com/haskell-nix/hnix/workflows/Hackage,%20Cabal,%20Linux/badge.svg)](https://github.com/haskell-nix/hnix/actions?query=workflow%3A"Hackage%2C+Cabal%2C+Linux"+branch%3Amaster) |
|
||||
|
@ -8,21 +19,7 @@
|
|||
| [![Release dependencies](https://img.shields.io/hackage-deps/v/hnix?label=Release%20dependencies)](https://packdeps.haskellers.com/feed?needle=hnix) | [![Nixpkgs, macOS](https://github.com/haskell-nix/hnix/workflows/Nixpkgs,%20macOS/badge.svg)](https://github.com/haskell-nix/hnix/actions?query=workflow%3A%22Nixpkgs%2C+macOS%22+branch%3Amaster) |
|
||||
| [![Repology page](https://img.shields.io/badge/Repology-page-%23005500)](https://repology.org/project/haskell:hnix/versions) | |
|
||||
|
||||
Haskell parser, evaluator and type checker for the Nix language.
|
||||
|
||||
## Contents
|
||||
|
||||
<!-- TOC -->
|
||||
- [Prerequisites](#prerequisites)
|
||||
- [Getting Started](#getting-started)
|
||||
- [Using the REPL](#using-the-repl)
|
||||
- [Building with full debug info](#building-with-full-debug-info)
|
||||
- [Building with benchmarks enabled](#building-with-benchmarks-enabled)
|
||||
- [Building with profiling enabled](#building-with-profiling-enabled)
|
||||
- [Using the Cachix binary cache](#using-the-cachix-binary-cache)
|
||||
- [Contributing](#contributing)
|
||||
- [Evaluating Nixpkgs with HNix](#evaluating-nixpkgs-with-hnix)
|
||||
<!-- /TOC -->
|
||||
---
|
||||
|
||||
## Prerequisites
|
||||
Until `hnix-store` is ready, `nix-store` is still used for interacting with the store paths, so Nix is still required installed and available through `$PATH`.
|
||||
|
|
Loading…
Reference in a new issue