No description
| src | fix: handle potential cloning error | |
| .gitignore | docs: update README with building/running instructions | |
| Cargo.lock | feat: add improved arguement parsing | |
| Cargo.toml | build: add release build optimisations | |
| deny.toml | initial commit | |
| LICENSE | initial commit | |
| README.md | chore: fix formatting in README | |
Sphenedata
Sphenedata is a CLI tool to show information about a git repository.
Building & Running
Build
To build the project, follow these steps:
- Ensure Rust is installed and the
cargocommand is on yourPATH. - Open your terminal and
cdinto the folder containing the Sphenedata repository. - Run the command
cargo build. This should compile a debug build in thetarget/debug/directory.
Run
To run the project, follow steps 1-2 from above, but instead of running cargo build, run cargo run. This should compile a debug build in the target/debug/ directory and then run it.
You can pass arguements to the program from Cargo like this:
cargo run -- --example-arg
Replacing --example-arg with the arg(s) you want to pass. For example, to show the help screen:
cargo run -- -h
Or to show infomation about the Sphenedata repository:
cargo run -- -p ../Sphenedata
License
This project is licensed under the GNU General Public License ONLY.