Skip to content

Commit

Permalink
Doc: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Lucas-C committed Jan 21, 2025
1 parent 6bcb51e commit cc4a031
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,20 @@ Example `.pkg` file:
url=git@github.com:motis-project/fmt.git
branch=master
commit=3eca62d66c7c9a2ca97dc8381299d911978b9fb2

## Useful commands
After invoking `CMake`, the `pkg` binary executable can be found in `build/dl/`.

### Displaying the dependency tree

pkg -s

### Syncing deps/
After updating a commit ID in the `.pkg` file,
you can `pkg -l` to establish the dependency tree state described in the `.pkg` file.
Effectively, `git` repositories will be updated in `deps/`.

You can use `-f` to force checkout the commits.

> [!WARNING]
> This will override the changes you made, so be careful.

0 comments on commit cc4a031

Please sign in to comment.