Skip to content

Commit

Permalink
Docs(README): Fix example configuration
Browse files Browse the repository at this point in the history
As mentioned in #23, the TOML was invalid in multiple ways. It should
now be a bit better.

Signed-off-by: Paul Mabileau <paul.mabileau@harfanglab.fr>
  • Loading branch information
PaulDance committed Jun 4, 2024
1 parent 664f4db commit d2c7ae3
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -672,11 +672,12 @@ properly-formed TOML document respecting the following format:
[packages]
package-name-1 = "version-req-1"
package-name-2 = "version-req-2"
package-name-3 = {
version = "version-req-3",
all-features = boolean,
default-features = boolean,
features = ["feature-1", "feature-2"],

[packages.package-name-3]
version = "version-req-3"
all-features = boolean
default-features = boolean
features = ["feature-1", "feature-2"]
index = "http://example.com/"
registry = "example-registry"
git = "http://example.com/exa/mple.git"
Expand All @@ -693,9 +694,8 @@ package-name-3 = {
frozen = boolean
locked = boolean
offline = boolean
extra-arguments = ["--arg1", "--arg2"],
environment = { ENV1 = "abc", ENV2 = "def" },
}
extra-arguments = ["--arg1", "--arg2"]
environment = { ENV1 = "abc", ENV2 = "def" }
#...
```

Expand Down

0 comments on commit d2c7ae3

Please sign in to comment.