Skip to content

Conversation

@ivanperez-keera
Copy link
Member

Add the missing dependency on libz-dev to the installation instructions for Linux in the README, as prescribed in the solution proposed for #314.

…ME. Refs nasa#314.

The installation instructions are missing the dependency on `libz-dev`,
which makes it hard for people to follow them to install Ogma,
especially if they are not familiar with Haskell, where it is a common
requirement.

This commit modifies the installation instructions in the README to adds
`libz-dev` to the list of dependencies needed in the call to `apt-get`.
@ivanperez-keera
Copy link
Member Author

Change Manager: Verified that:

  • Solution is implemented:
    • The code proposed compiles and passes all tests. Details:
    • The solution proposed produces the expected result. Details:
      The following Dockerfile installs Ogma following the steps in the README, after which it prints the message "Success":
      FROM ubuntu:22.04
      
      ENV DEBIAN_FRONTEND=noninteractive
      
      RUN apt-get update
      SHELL ["/bin/bash", "-c"]
      
      RUN apt-get install --yes ghc cabal-install pkg-config g++
      
      WORKDIR /root/
      
      ENV PATH=/root/.cabal-sandbox/bin:$PATH
      
      RUN cabal update
      RUN cabal v1-sandbox init
      RUN apt-get install --yes git
      RUN apt-get install --yes libz-dev libbz2-dev libexpat1-dev
      RUN cabal v1-install alex happy
      RUN cabal v1-install BNFC
      
      SHELL ["/bin/bash", "-c"]
      CMD git clone $REPO \
        && pushd $NAME \
        && git checkout $COMMIT \
        && popd \
        && cabal v1-install --force-reinstalls --constraint="aeson>=2.0.3.0" $NAME/ogma-**/ \
        && echo "Success"
      Command (substitute variables based on new path after merge):
      $ docker run -e REPO=https://github.com/ivanperez-keera/ogma -e NAME=ogma -e COMMIT=200e9ad65bbc3070337b873f9525eb3e86a161a3 ogma-verify-314
      
  • Implementation is documented. Details:
    Change is to the documentation.
  • Change history is clear.
  • Commit messages are clear.
  • Changelogs are updated.
  • Examples are updated. Details:
    No updates needed; change is to the README.
  • Author is internal or has provided signed CLA.
  • Required version bumps are evaluated. Details:
    Bump not required; change does not alter public interface.

@ivanperez-keera ivanperez-keera merged commit f236737 into nasa:develop Nov 23, 2025
3 checks passed
@ivanperez-keera ivanperez-keera deleted the develop-readme-libz-dev branch November 23, 2025 02:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant