Skip to content

update documentation, readme and guides #314

@MSalopek

Description

@MSalopek

Checking the guides, I was not able to find an instruction to install quartz via cargo without needing to pull the repo (cargo install quartz-rs).

The paths in instructions are referencing https://github.com/informalsystems/cycles-quartz, but the path has changed to https://github.com/informalsystems/quartz.

Parts of https://github.com/informalsystems/quartz/blob/main/docs/getting_started.md should be in the root Readme and it should specify that installation (cargo) should be done like this:

sudo apt update
sudo apt upgrade -y
sudo apt install build-essential clang libclang-dev pkg-config libssl-dev protobuf-compiler ca-certificates
cargo install quartz-rs # install quartz after installing all deps

Task

Make sure the instructions are correct and can be followed without encountering errors.

  • check install instructions (from source, via cargo)
  • check guides for correctness
  • make the Readme in the root of the repository provide only necessary info such as install instructions and what to read next

Metadata

Metadata

Assignees

No one assigned

    Labels

    devxIssues related to improving dev experience / toolingdocumentationImprovements or additions to documentation

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions