Skip to content

Clarify build instructions #374

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

Merged
merged 1 commit into from
Feb 5, 2025
Merged

Clarify build instructions #374

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
11 changes: 10 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,15 @@ this file, see the
}
```

With both files your project directory should look like this:
```
.
├── model
│ └── main.smithy
└── smithy-build.json
```


The code generator, `smithy-python-codegen`, hasn't been published yet, so
you'll need to build it yourself. To build and run the generator you will need
the following prerequisites:
Expand All @@ -117,7 +126,7 @@ install the python dependencies in your environment and make the code generator
available locally. For more information on the underlying build process, see the
"Using repository tooling" section.

Now from your model directory run `smithy build` and you'll have a generated
Now from your project directory run `smithy build` and you'll have a generated
client! The client can be found in `build/smithy/client/python-client-codegen`.
The following is a snippet showing how you might use it:

Expand Down