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

Rewrite README instructions to use pipx #84

Merged
merged 5 commits into from
Dec 1, 2023
Merged

Rewrite README instructions to use pipx #84

merged 5 commits into from
Dec 1, 2023

Conversation

pkalita-lbl
Copy link
Contributor

Fixes #81

Mainly this is updating the README to give instructions on getting set up using pipx instead of creating the "wrapper" Poetry environment.

While making sure that everything in the README works out of the box I made two additional changes:

  • Updated a few of the git-related Makefile targets so that there are no uncommitted files still hanging around after the initial commit
  • Removed the git-init target from install and added it to setup. There are valid reasons you might want to run make install again later and you don't want to call git init at that point.
  • Removed the instruction to call make deploy from the README. I don't think we want to encourage people doing this manually especially since we have a GitHub Action that does it.
  • Fixed the unit test to account for the default example file now being a collection (fix default example to be a collection of entries #72)

@@ -58,11 +58,10 @@ status: check-config
@echo "Source: $(SOURCE_SCHEMA_PATH)"

# generate products and add everything to github
setup: install gen-project gen-examples gendoc git-init-add
setup: git-init install gen-project gen-examples gendoc git-add git-commit
Copy link
Member

Choose a reason for hiding this comment

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

thank you!

Copy link
Collaborator

@hrshdhgd hrshdhgd left a comment

Choose a reason for hiding this comment

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

  • Were we not doing recommit hooks in this cookiecutter?
  • Do we want to include that here or some other time (different PR).

@pkalita-lbl
Copy link
Contributor Author

  • Were we not doing recommit hooks in this cookiecutter?
  • Do we want to include that here or some other time (different PR).

I guess we're not at the moment. It's not a bad idea, but let's make a new issue for that.

@pkalita-lbl pkalita-lbl merged commit dc8af4e into main Dec 1, 2023
1 check passed
@pkalita-lbl pkalita-lbl deleted the issue-81 branch December 1, 2023 23:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rework installation docs
3 participants