Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update protoc_plugin README install commands @V2 #559

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update protoc_plugin README install commands @V2 #559

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion protoc_plugin/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,17 @@ How to build and use
*Note:* currently the workflow is POSIX-oriented.

To build standalone `protoc` plugin:
- run `pub install` to install all dependencies
- Dart version 2
- run `$ dart pub add protoc_plugin && dart pub get && dart pub global activate protoc_plugin`
- Flutter version 2
- run `$ flutter pub add protoc_plugin && flutter pub get && flutter pub global activate protoc_plugin`
- legacy: Dart/Flutter version 1
- run `pub install` to install all dependencies

Ensure the plugin is in your `PATH`:
- Now you can use the plugin either by adding the `bin` directory to your `PATH`,
or passing it directly with `protoc`'s `--plugin` option.
- Example: `$ export PATH="$PATH":"$HOME/Code/flutter/.pub-cache/bin"`

Please, remember that the plugin is pure Dart script and requires the presence
of `dart` executable in your `PATH`.
Expand Down