Cabal (#3)

.gitignore

@@ -1,5 +1,85 @@
-.stack-work/
+.cabal-sandbox/
+cabal.sandbox.config
+cabal.project.local
+.ghc.environment.*
+cabal-dev/
+.hpc/
+*.hi
+*.o
+*.p_hi
+*.prof
+*.tix
+dist
+dist-*
+register.sh
+./cabal.config
+cabal-tests.log
+bootstrap/*.plan.json
+
+/Cabal/dist/
+/Cabal/tests/Setup
+/Cabal/Setup
+/Cabal/source-file-list
+
+/cabal-install/dist/
+/cabal-install/Setup
+/cabal-install/source-file-list
+
+.stylish-haskell.yaml
+.stylish-haskell.yml
+.ghci
+.ghcid
+
+# Output of release and bootstrap
+_build
+
+# editor temp files
+
+*#
+.#*
 *~
+.*.swp
+*.bak
+
+# GHC build
+
+Cabal/GNUmakefile
+Cabal/dist-boot/
+Cabal/dist-install/
+Cabal/ghc.mk
+
+
+# TAGS files
+TAGS
+tags
+ctags
+
+# stack artifacts
+/.stack-work/
+stack.yaml.lock
+
+# Shake artifacts
+.shake*
+progress.txt
+
+# test files
+register.sh
+
+# windows test artifacts
+cabal-testsuite/**/*.exe
+cabal-testsuite/**/*.bat
+
+# python artifacts from documentation builds
+*.pyc
+.python-sphinx-virtualenv/
+/doc/.skjold_cache/
+
+# macOS folder metadata
 .DS_Store
-result
-test/dst/
+
+# benchmarks
+bench.html
+
+# Emacs
+.projectile
+/test/dst/

ChangeLog.md

@@ -1,3 +1,5 @@
-# Changelog for answers-script
+# Revision history for answers-script
 
-## Unreleased changes
+## 0.1.0.0 -- YYYY-mm-dd
+
+* First version. Released on an unsuspecting world.

README.md

@@ -1 +1,42 @@
-# answers-script
+# Answers Script
+
+## Generate default.nix
+
+```shell
+nix-shell -p cabal2nix
+cabal2nix --no-check ./. > default.nix
+```
+
+## Generate shell.nix
+
+```shell
+nix-shell -p cabal2nix
+cabal2nix --shell --no-check ./. > shell.nix
+```
+
+## Build
+
+**Don't just build using Cabal!!** it will take forever because of Pandoc.
+
+Build in Nix environment
+
+```shell
+# Enter Nix environment defined in shell.nix
+nix-shell
+# Use executable
+answers-script ...
+```
+
+## Test
+
+```shell
+nix-shell
+cabal --enable-nix test
+```
+
+## Install from other machines
+
+```shell
+TAR="https://github.com/ingun37/answers-script/archive/refs/tags/test2.tar.gz"
+nix-shell -p "with import <nixpkgs> {}; let f = import (fetchTarball $TAR); in haskellPackages.callPackage f {}"
+```