Skip to content

Setup Guide

jingling edited this page May 31, 2024 · 3 revisions

Getting Started

You can build and install RUPTA into cargo from source code.

Requirement

RUPTA requires Rust nightly, as specified in the rust-toolchain.toml file.

If you do not currently have Rust installed on your system, you can find the installation instructions here.

Build and Install RUPTA

Clone the repository:

git clone https://github.com/rustanlys/rupta.git
cd rupta

To install RUPTA into Cargo, run the command:

cargo --locked install --path .

Alternatively, you can build RUPTA only:

cargo build

Running this command produces two binaries, cargo-pta and pta, in target/debug. To compile in release mode, run cargo build --release instead, which will place the resulting binaries in target/release.

Troubleshooting

You may encounter errora when running RUPTA: dyld: Library not loaded. Try setting the environment variable LD_LIBRARY_PATH on Linux or DYLD_LIBRARY_PATH on macOS:

export DYLD_LIBRARY_PATH=/Users/$USER/.rustup/toolchains/nightly-YYYY-MM-DD-TA/lib/

RUPTA works with a specific version of the rust toolchain. When multiple toolchains are installed on your machine, you can specify the toolchain version when running the cargo command:

cargo +toolchain pta  # replace `toolchain` with the channel version in the `rust-toolchain.toml` file

Contributing to RUPTA

If you want to participate in the further development of RUPTA, please refer to the RUPTA Design documentation. This guide provides some detailed insights into the architecture and design principles of RUPTA, helping you contribute effectively to its ongoing development.


The above installation guide has been tested on macOS 12.0, Ubuntu 20.04, and Windows Subsystem for Linux (WSL v10.0), but it should work on most Linux-based systems.

Clone this wiki locally