monarrk
/
pack
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Updated README

This commit is contained in:
Skye Bleed 2019-09-03 18:20:38 -05:00
parent d5a373901e
commit d86b34800f
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -16,11 +16,13 @@ This has hardly been worked on and is essentially useless at its current state.
[ ] More, probably
### Building and Setup
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. Soon, the setup script will be written in lua and instructions on how to do so from bash will be here.
This project can be built automatically using a lua script found in ./scripts/build. If you do not have lua or otherwise do not wish to use this script, you can do it manually as well.
To manually build and set up, first run `cargo build --release`. Then, run scripts/setup.sh to setup your environment. Then copy target/release/pack to somewhere in your path, such as ~/.local/bin.
### Usage
Firstly, to setup your environment, run scripts/arch.sh. The syntax of the command is as follows:
`sudo pack {url}::{repo type}`
`sudo pack {package name}::{repo type}`
This will add the tarball found at {url} to /usr/pack/repo/{repo type}/tarballs.
This will add the tarball found at {package name} to /usr/pack/repo/{repo type}/tarballs.