Skip to content

Update the instructions for building from source in README.md #472

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.

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

Closed
wants to merge 2 commits into from
Closed

Update the instructions for building from source in README.md #472

wants to merge 2 commits into from

Conversation

adolfogc
Copy link
Contributor

Issue #, if available:

The current instructions for building from source can be improved.

Description of changes:

Updates the instructions for building from source, noting that an additional step is required so that the package is installed with the correct version number.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@xiazhvera
Copy link
Contributor

Thanks for the contribution!
We intentionally set the version number as 1.0.0-dev to distinguish a local build from the released versions. It's not required to set the version number while building from source.
I will make the following update and bring in the changes:

  • Marking the version part as optional
  • Create a dedicate section to explain how to set versions

@adolfogc
Copy link
Contributor Author

adolfogc commented Jun 24, 2023

Hi, thank you for the reply. The version string is not optional in the case of the awscrt package when you have to build it from source as a dependency for the iot-sdk package. Otherwise it gets rebuilt, which could be problematic if you had built it using the system's libcrypto, as it wouldn't be the case for the second time it gets build.

@xiazhvera
Copy link
Contributor

I added more explanation to the version strings and build instruction. Hopefully, it would be clearer about the issue with the version string. Feel free to comment with feedback.
https://github.com/aws/aws-iot-device-sdk-python-v2/pull/477/files

@xiazhvera
Copy link
Contributor

Closed as the change is merged in at: #477

@xiazhvera xiazhvera closed this Jun 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants