Skip to content

Commit

Permalink
docs: improve grammatical flow
Browse files Browse the repository at this point in the history
  • Loading branch information
ken-matsui authored Dec 24, 2024
1 parent 779e0c8 commit f12f87e
Showing 1 changed file with 3 additions and 6 deletions.
9 changes: 3 additions & 6 deletions docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Poac uses a cache since we executed the command with no changes.
## Install dependencies
Like Cargo does, Poac installs dependencies at build time. Poac currently supports Git, path, and system dependencies. You can use two methods to add dependencies to your project: the `poac add` command, and editing `poac.toml` directly.
Like Cargo does, Poac installs dependencies at build time. Poac currently supports Git, path, and system dependencies. You can use two ways to add dependencies to your project: using the `poac add` command and editing `poac.toml` directly.
### `poac add`
Expand All @@ -71,11 +71,9 @@ poac add libgit2 --sys --version "1.1.0"
poac add "ToruNiina/toml11" --rev "846abd9a49082fe51440aa07005c360f13a67bbf"
```
If `tag`, `branch`, or `rev` is unspecified for git dependencies, Poac will use the latest revision of the default branch. System dependency names must be acceptable by `pkg-config`. The version requirement syntax is specified in [src/VersionReq.hpp](https://github.com/poac-dev/poac/blob/main/src/VersionReq.hpp).

### editing `poac.toml` directly
### Editing `poac.toml` directly

The syntax for `poac.toml` like below:
The syntax for `poac.toml` is as follows:

```toml
[dependencies]
Expand All @@ -92,7 +90,6 @@ fmt = { version = ">= 9", system = true }

If `tag`, `branch`, or `rev` is unspecified for git dependencies, Poac will use the latest revision of the default branch. System dependency names must be acceptable by `pkg-config`. The version requirement syntax is specified in [src/VersionReq.hpp](https://github.com/poac-dev/poac/blob/main/src/VersionReq.hpp).


After adding dependencies, executing the `build` command will install the package and its dependencies.

```console
Expand Down

0 comments on commit f12f87e

Please sign in to comment.