diff --git a/README.md b/README.md index 73af7eb..fc0699a 100644 --- a/README.md +++ b/README.md @@ -6,10 +6,21 @@ This has hardly been worked on and is essentially useless at its current state. ### TODO [ ] Parse cmdline options well, including parsing the package name from the package repo + [ ] Make a KO + [ ] Correctly download from several repos + [ ] Unpack tarballs of various types + [ ] More, probably ### Building This project is made in the rust programming language, so a simple `cargo run` will suffice to build the binary. In addition, you may wish to run `scripts/setup.sh` to configure your environment. + +### Usage +Firstly, to setup your environment, run scripts/arch.sh. The syntax of the command is as follows: + +`sudo i {url}::{repo type}` + +This will add the tarball found at {url} to /imperfect/repo/{repo type}/tarballs.