commit 799f242b16c453a675a6955c652da3415753152a parent b3a27af943650f2658b54497a60ab3fe8a3c3c4f Author: finwo <finwo@pm.me> Date: Thu, 10 Jan 2019 15:58:27 +0100 Made the readme somewhat useful Diffstat:
| M | README.md | | | 58 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++- |
1 file changed, 57 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md @@ -18,4 +18,60 @@ curl https://raw.githubusercontent.com/cdeps/dep/master/install.sh | bash ## Usage -TODO +### Initialize a project with DEP + +```bash +dep init +``` + +Go into the repository you want to initialize and run `dep init`. This will create the file `.dep` which contains all that is needed for dep to work with. + +### Add a dependency + +```bash +dep add <package-name> +``` + +### Install dependencies + +```bash +dep install +``` + +You can also install a single package without adding it to the dependencies by running `dep install <package-name>` + +### Remove a dependency + +This is not implemented yet + +### Update packages from repositories + +```bash +dep repo update +``` + +### Show which repositories are used + +```bash +dep repo list +``` + +### Add a repository + +```bash +dep repo add <url> +``` + +### Clean repository cache + +```bash +dep repo clean +``` + +## TODO + +- Add remove-dep tool +- Make the source nicer to read +- Better documentation +- Pick a proper name +- Focus on C instead of general purpose?