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

README: fix the slightly misleading doc #30

Merged
merged 1 commit into from
Oct 13, 2023
Merged

README: fix the slightly misleading doc #30

Show file tree
Hide file tree
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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ import (
To make changes to this API, you:

1. Edit the specific `.proto` files in the [proto](./proto) directory, or create new ones, as desired.
1. Run `make proto` to generate the language-specific bindings and visualizations.
1. Run `make` to generate the language-specific bindings and visualizations.
1. Commit the changes to the `.proto` files and the generated files.

The Pull Request process for this repository will regenerate the language-specific bindings and visualizations,
Expand Down Expand Up @@ -74,7 +74,7 @@ make python

### Visualizations

In addition to the language-specific libraries, `make proto` generates visualizations of the protobuf structure,
In addition to the language-specific libraries, `make` generates visualizations of the protobuf structure,
beginning with the root of an edge device config. These are
available as `.svg`, `.dot` and `.png` as below. Click to zoom in.

Expand Down
2 changes: 1 addition & 1 deletion go/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import (
To build, go to the root directory of this repository and:

```bash
make proto
make
```

To vendor the result into a downstream dependency, e.g. pillar, do the following:
Expand Down