git.iko.soy/rowtype-yoga/package-sets
on master help sign in
Update CONTRIBUTING.md (#590)

Co-authored-by: Fabrizio Ferrai <fabrizio.ferrai@gmail.com>

commit0cda31b3234a2fa2add112147f4bc2b12163c2a0 authorflip111 <flip101@gmail.com> dateSat 4 Apr 2020, 19:20 (7 years ago) parent78c6482
1 file changed+15−8
CONTRIBUTING.md+15−8
CONTRIBUTING.md+15−8
@@ -73,6 +73,21 @@ You can do so by [opening an issue][issues]
7373
7474## How to add a package to the set
7575
76+### Prerequisites
77+
78+To hack on this project, it should be enough to have [nix](https://nixos.org/nix/download.html) installed. You can verify your changes with
79+
80+ nix-shell --command make
81+
82+
83+If you're unable to run Nix, then you should have the following installed:
84+- [dhall]
85+- [dhall-to-json][dhall]
86+- [spago]
87+- [psc-package]
88+
89+### TL;DR
90+
7691The following section will detail how to add a package to the package-set.
7792
7893The *TL;DR* about it is:
@@ -133,14 +148,6 @@ This is the file used to generate the `packages.json`.
133148// ./groups/justinwoo.dhall
134149```
135150
136−#### Prerequisites
137−
138−In order to hack on this project, you should have installed:
139−- [dhall]
140−- [dhall-to-json][dhall]
141−- [spago]
142−- [psc-package]
143−
144151### 1. Adding a new package
145152
146153To add a new package to the package set, you should create a package definition matching the Package type, and put it in the group file corresponding to the author's username.