How to install

⚠️ I don't have a windows or macos machine so I have not tested this in those machines, but the CI passes the cargo build. You are more then welcome to test and report any issues.

Install locally

To install vipyrdocs to your machine you can use the cargo installer.

git clone https://github.com/alithethird/vipyrdocs.git
cd vipyrdocs
cargo install --path .

This will install the vipyrdocs executable to your cargo bin path which is usually ~/.cargo/bin.

Use without installing

there are 2 ways to use the vipyrdocs without installing:

• building the executable
• running the code directly

Building

You can build the executable with cargo and use it without installing into your machine:

cargo build --release

This will put the executable in the ./vipyrdocs/target/release folder.

Running directly

Another alternative to test out the vipyrdocs project is just running it:

cargo run