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

Prepare for initial release #32

Merged
merged 3 commits into from
Sep 29, 2023

Conversation

andy-sweet
Copy link
Contributor

This makes some updates to prepare for the first release of this driver. Specifically it

  • adds a changelog with the unreleased major features included so far;
  • updates the README to include important installation, usage, and development instructions;
  • logs the spinnaker version on driver construction to help with debugging version incompatibility issues.

Note that it does not actually create a release yet. Instead I plan to create a PR that only modifies the CHANGELOG, then merge that into a single commit with an associated version tag.

Partially addresses #31

@andy-sweet andy-sweet requested a review from aliddell September 28, 2023 21:26
Copy link
Member

@aliddell aliddell left a comment

Choose a reason for hiding this comment

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

Looks good.

Comment on lines +7 to +8
The intended way to use this library is as part of the [acquire-imaging](https://github.com/acquire-project/acquire-python)
Python package, which also includes Acquire's runtime as well as other drivers.
Copy link
Member

Choose a reason for hiding this comment

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

I'd say typical rather than intended, but maybe it's just a nit.

@andy-sweet andy-sweet merged commit 1e32020 into acquire-project:main Sep 29, 2023
2 checks passed
@andy-sweet andy-sweet deleted the prep-init-release branch September 29, 2023 17:05
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