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

[issue-391] update readme to reflect the new usage after refactoring #495

Merged
merged 2 commits into from Feb 27, 2023
Merged

[issue-391] update readme to reflect the new usage after refactoring #495

merged 2 commits into from Feb 27, 2023

Conversation

armintaenzertng
Copy link
Collaborator

fixes #391

@armintaenzertng
[issue-391] update readme to reflect the new usage after refactoring
0b0fb60 
Signed-off-by: Armin Tänzer <armin.taenzer@tngtech.com>
meretp
meretp requested changes Feb 27, 2023
View reviewed changes
Copy link
Collaborator

@meretp meretp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for updating this, I especially like the examples and the description for the library usages, I think this makes adaption much easier. I am not really satisfied with the paragraph to the current state, see my comment below.

README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated
of this repo with `yourenv/bin/pip install .` or install it from PyPI with
`yourenv/bin/pip install spdx-tools`. Note that on Windows it would be `Scripts`
instead of `bin`.
## Library usage:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Library usage:
## Library usage

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
meretp
meretp reviewed Feb 27, 2023
View reviewed changes
README.md Outdated
* uritools: https://pypi.org/project/uritools/ for validation of URIs.
* license_expression: https://github.com/nexB/license-expression for handling SPDX license expressions.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

for consistency we could use the pypi link here

@armintaenzertng
[issue-391, review] update readme: "Current state", add license_expre…
ed1f920 
…ssion to dependencies

Signed-off-by: Armin Tänzer <armin.taenzer@tngtech.com>
meretp
meretp approved these changes Feb 27, 2023
View reviewed changes
Copy link
Collaborator

@meretp meretp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@armintaenzertng armintaenzertng merged commit 9315e42 into spdx:refactor-python-tools Feb 27, 2023
@armintaenzertng armintaenzertng deleted the updateRefactoredReadme branch February 27, 2023 11:53
@armintaenzertng armintaenzertng mentioned this pull request Feb 27, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@meretp meretp meretp approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@armintaenzertng @meretp