Skip to content

Commit 5537813

Browse files
ulysses4evervidsinghal
authored andcommitted
minor cleanup of README and gibbon-compiler/gibbon.cabal
1 parent 9adcc1b commit 5537813

File tree

2 files changed

+11
-10
lines changed

2 files changed

+11
-10
lines changed

README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,12 @@ similar to Typed Racket, and a small subset of Haskell.
2525

2626
## Building Gibbon
2727

28-
Gibbon is implemented in Haskell, and is set up to be built with
29-
[Cabal](https://cabal.readthedocs.io/en/3.4/).
28+
### Getting Dependencies
3029

31-
Follow the instructions below to have all dependencies.
30+
Gibbon is implemented in Haskell, and is set up to be built with
31+
[Cabal](https://cabal.readthedocs.io/en/latest/), but it has a number of native dependencies.
32+
Follow the instructions below to get all dependencies or enter the Nix shell
33+
with `nix-shell` to get them via [Nix](https://nix.dev/).
3234

3335
- Ubuntu 22.04:
3436
(Parallelism support temporarily not available with ubuntu 22.04 as Cilk support is not avaiable with newer gcc)
@@ -77,24 +79,25 @@ Others require a few extra steps:
7779

7880
2. [uthash](https://github.com/troydhanson/uthash): Clone the [repository](https://github.com/troydhanson/uthash) and copy all the `.h` files in `src` to `/usr/local/include`
7981

82+
### Actually Building Gibbon
8083

8184
After you have both Cabal and all the dependencies installed, you can build
8285
Gibbon from source:
8386

8487
$ git clone https://github.com/iu-parfunc/gibbon
8588
$ cd gibbon && source set_env.sh
86-
$ cd gibbon-compiler && cabal v2-build . -w ghc-9.4.6
89+
$ cd gibbon-compiler && cabal v2-build
8790

8891
At this point you can run the Gibbon executable:
8992

90-
$ cabal v2-exec -w ghc-9.4.6 gibbon -- -h
93+
$ cabal v2-run gibbon -- -h
9194

9295
If you'd like to run the testsuite, you can do so with:
9396

94-
$ cd $GIBBONDIR && ./run_all_tests.sh
97+
$ ./run_all_tests.sh
9598

9699

97-
## Building a Developement docker container for Gibbon
100+
### Building a Developement docker container for Gibbon
98101

99102
To build the Dockerfile for dev purposes run the command below from the gibbon directory.
100103

gibbon-compiler/gibbon.cabal

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
cabal-version: >=1.10
1+
cabal-version: 2.0
22

33
name: gibbon
44
version: 0.3
@@ -15,9 +15,7 @@ category: Compilers/Interpreters
1515
extra-source-files: README.md
1616
build-type: Simple
1717
extra-source-files: README.md
18-
cabal-version: >=1.10
1918
tested-with: GHC==9.4.6
20-
, GHC==9.4.5
2119
, GHC==9.2.8
2220
, GHC==9.0.2
2321
, GHC==8.10.7

0 commit comments

Comments
 (0)