Skip to content

Commit

Permalink
Merge branch 'develop-readme-cabalUpdate' into develop. Close #100.
Browse files Browse the repository at this point in the history
**Description**

The installation instructions in the README do not mention the `cabal update`
step. This is confusing users unfamiliar with Haskell, since it's not obvious
that cabal should have to be updated before installing Ogma.

**Type**

- Bug: installation instructions are incomplete.

**Additional context**

None.

**Requester**

- Ivan Perez

**Method to check presence of bug**

The issue is with the documentation. There is no good, simple automated way to
check that it is correct.

Because it's not a programming issue, visual inspection is OK.

**Expected result**

The README's installation instructions list the update step prior to
installation.

**Solution implemented**

Modify the installation instructions in `README.md` to include the cabal update
step.

**Further notes**

None.
  • Loading branch information
ivanperez-keera committed Nov 22, 2023
2 parents 6d7ebba + 94a5958 commit a56a2f8
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 0 deletions.
4 changes: 4 additions & 0 deletions ogma-cli/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Revision history for ogma-cli

## [1.X.Y] - 2023-11-21

* Document cabal update step in README (#100).

## [1.0.11] - 2023-09-21

* Version bump 1.0.11 (#103).
Expand Down
1 change: 1 addition & 0 deletions ogma-cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@ Once GHC and cabal are installed, the simplest way to install Ogma is with:
$ git clone https://github.com/nasa/ogma.git
$ cd ogma
$ export PATH="$HOME/.cabal/bin/:$PATH"
$ cabal v1-update
$ cabal v1-install alex happy
$ cabal v1-install BNFC copilot
$ cabal v1-install ogma-*/
Expand Down

0 comments on commit a56a2f8

Please sign in to comment.