Skip to content

copilot: Include missing dependencies in installation instructions #591

Closed
@ivanperez-keera

Description

@ivanperez-keera

Description

The Linux section of the README lists GHC and Cabal as dependencies, but more packages are needed. Specifically, in a fresh new Ubuntu as provided via the Docker hub, users also need to install libz-dev and pkg-config. The programs alex and happy also need to be available. The instructions should be updated to include those packages.

Type

  • Bug: Installation instructions are incomplete.

Additional context

None.

Requester

  • Martin Halle (Technische Universität Hamburg, TUHH).

Method to check presence of bug

Installing Copilot in a fresh Ubuntu image with only GHC and Cabal produces the following error:

Configuring zlib-0.7.1.0...
cabal: The program 'pkg-config' version >=0.9.0 is required but it could not
be found.

Adding that program reports similar errors regarding the packages listed above.

Expected result

Replicating the installation instructions from the README in a fresh Docker Ubuntu image should render an installation capable of Compiling one of the sample specifications included with Copilot.

Desired result

Replicating the installation instructions from the README in a fresh Docker Ubuntu image should render an installation capable of Compiling one of the sample specifications included with Copilot.

Proposed solution

Update README to include libz-dev, pkg-config, alex and happy in the apt-get line under "Other Linux distributions".

Further notes

None.

Metadata

Metadata

Labels

CR:Status:ClosedAdmin only: Change request that has been completedCR:Type:BugAdmin only: Change request pertaining to error detected

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions