Skip to content

Latest commit

 

History

History
54 lines (33 loc) · 1.34 KB

building.rst

File metadata and controls

54 lines (33 loc) · 1.34 KB

Building

The build stack uses the Rust development tools on your system. Install these on your system with rustup if they are not already available.

The following dependencies are also needed to build the project.

  • CMake: Needed by Cargo tool library dependency.
  • Libssl: Needed by Cargo tool library dependency.

A rkt container build script is included in the project repository and provides an installation which can be used to build the project also. See the description on building and running the container in the :ref:`dev` section of this document for details.

For macOS, RktMachine provides a CoreOS VM which supports developing using the rkt container system.

To build and test the project, use:

cargo test

A development version of the Cargo Sphinx extension can be installed locally using:

cargo install --path .

(--force is necessary if Cargo Sphinx has previously been installed.)

Run an installed development version to test the Sphinx generation:

cargo sphinx

Use --dry-run to see the --push steps.

cargo sphinx --push --dry-run