Update readme #540
Merged
Update readme #540
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| @@ -301,10 +301,10 @@ mod color; | |||
| And finally the last feature! Just run the following command (note the `-m doc` at the end): | |||
|
|
|||
| ```shell | |||
| cargo run --release -- -c YourGirFile.toml -d ../gir-files -o the-output-directory -m doc | |||
| cargo run --release -- -c YourGirFile.toml -d ../gir-files --doc-target-path the-output-file-name -m doc | |||
There was a problem hiding this comment.
The -o option isn't used for docs generation?
There was a problem hiding this comment.
It can be used, but file name will be "vendor.md"
There was a problem hiding this comment.
yes, that made things a bit awkward in gstreamer
|
Ok, I merge this as no one against it. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Followup of #539
cc @GuillaumeGomez , @MathieuDuponchelle