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.

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

doc: Quickstart guide #4531

Merged
merged 2 commits into from
Nov 17, 2024
Merged

Conversation

lgritz
Copy link
Collaborator

@lgritz lgritz commented Nov 9, 2024

Having such a document is one of the remaining steps to getting our OpenSSF Best Practices silver level badge.

Having such a document is ane of the remaining steps to getting
our OpenSSF Best Practices silver level badge.

Signed-off-by: Larry Gritz <[email protected]>
@lgritz lgritz added the docs Documentation label Nov 13, 2024
@lgritz
Copy link
Collaborator Author

lgritz commented Nov 15, 2024

This has been posted for a week without receiving any comments. Does anybody have feedback? It's meant to be an extremely brief "quickstart" that just shows how to do a simple image operation through each of the several interfaces and bindings of the project.

Copy link
Collaborator

@ThiagoIze ThiagoIze left a comment

Choose a reason for hiding this comment

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

Does the quickstart guide also need to explain how to build OIIO or is it just about using a tool? Could we add a link for where to go for more info?

@lgritz
Copy link
Collaborator Author

lgritz commented Nov 15, 2024

We already have the INSTALL.md (how good that is, perhaps, is debatable), so I was assuming this was the "use it" quickstart. But I should cross-link those documents.

@lgritz lgritz merged commit 1c3d694 into AcademySoftwareFoundation:main Nov 17, 2024
3 checks passed
@lgritz lgritz deleted the lg-quickstart branch November 18, 2024 06:59
lgritz added a commit to lgritz/OpenImageIO that referenced this pull request Nov 21, 2024
Having such a document is one of the remaining steps to getting our
OpenSSF Best Practices silver level badge.

---------

Signed-off-by: Larry Gritz <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants