Skip to content

haskell/cabal-userguide

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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!

Getting Nix

If you want to install nix please follow the instructions here

If you want to enable experimental features (the nix command) you can find documentation about getting that setup here

Running Locally

This project is built with mdbook and they have great documentation.

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 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

About

A handy user guide for the Cabal build tool

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages