https://github.com/haskell/cabal-userguide

A handy user guide for the Cabal build tool
https://github.com/haskell/cabal-userguide

Last synced: about 1 month ago
JSON representation

A handy user guide for the Cabal build tool

• Host: GitHub
• URL: https://github.com/haskell/cabal-userguide
• Owner: haskell
• Created: 2021-06-11T18:00:17.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-09-10T20:29:28.000Z (about 3 years ago)
• Last Synced: 2024-04-16T00:49:06.951Z (7 months ago)
• Language: Nix
• Size: 1.14 MB
• Stars: 29
• Watchers: 14
• Forks: 5
• Open Issues: 17
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Cabal User Guide

## Dependencies

All dependencies are provided via nix. This project is defined as a flake so you

can use `nix develop` to enter a shell if you have experimental features

enabled. There is also `flake-compat` setup so a regular `nix-shell` should work

if you don't want to use experimental features.

If you don't want to use nix you can install these dependencies by themselves.

It should be noted that the pre-commit-hooks are setup using nix, so if you want

to not use nix it might be convenient to setup your own commit hooks, or you can

run `prettier --write "./**/*.md"` on your own. CI will fail if markdown files

are not correctly formatted!

- [mdbook](https://rust-lang.github.io/mdBook/cli/index.html)

- [prettier](https://prettier.io/)

### Getting Nix

If you want to install nix please follow the instructions

[here](https://nixos.org/download.html)

If you want to enable experimental features (the `nix` command) you can find

documentation about getting that setup

[here](https://nixos.wiki/wiki/Nix_command)

## Running Locally

This project is built with mdbook and they have

[great documentation](https://rust-lang.github.io/mdBook/index.html).

The main command for development is `mdbook serve` which will run the book

locally on `localhost:3000`.

## Contributing

Chapters can be edited in their corresponding markdown files (see

[SUMMARY.md](./src/SUMMARY.md) for reference). To add a new chapter, add a link

in SUMMARY.md and then create the corresponding markdown file. For more in depth

instructions on adding content to an mdbook project see the

[official docs](https://rust-lang.github.io/mdBook/format/summary.html)