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

Add quick start section and gif demo to accompany it. #3044

Merged
merged 5 commits into from
Nov 20, 2024
Merged

Add quick start section and gif demo to accompany it. #3044

merged 5 commits into from
Nov 20, 2024

Conversation

madhu-GG
Copy link
Contributor

@madhu-GG madhu-GG commented Sep 2, 2024 •
edited
Loading

Make sure you have checked all steps below.

Prerequisite

  • Please consider implementing the feature as a hook script or plugin as a first step.
    • pyenv has some powerful support for plugins and hook scripts. Please refer to Authoring plugins for details and try to implement it as a plugin if possible.
  • Please consider contributing the patch upstream to rbenv, since we have borrowed most of the code from that project.
    • We occasionally import the changes from rbenv. In general, you can expect changes made in rbenv will be imported to pyenv too, eventually.
    • Generally speaking, we prefer not to make changes in the core in order to keep compatibility with rbenv.
  • My PR addresses the following pyenv issue (if any)

Description

  • Here are some details about my PR

This is a PR to add a quick start section to the github README.md along with a quick demo to show how to install and switch to a different python version using pyenv.

Tests

  • My PR adds the following unit tests (if any)

Not Applicable.

native-api
native-api reviewed Sep 2, 2024
View reviewed changes
Copy link
Member

@native-api native-api left a comment •
edited
Loading

Choose a reason for hiding this comment

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

This essentially duplicates the installation and usage sections -- and not in much fewer words, either!

Maybe rather move the installation section higher and/or make it more concise?

The gif is a good idea. Maybe worth showcasing the prefix resolution in it?
If the basic basic scenario is "install the latest CPython release", it could rather be done with pyenv install 3.

@madhu-GG
Copy link
Contributor Author

madhu-GG commented Sep 3, 2024

This essentially duplicates the installation and usage sections -- and not in much fewer words, either!

Maybe rather move the installation section higher and/or make it more concise?

The gif is a good idea. Maybe worth showcasing the prefix resolution in it? If the basic basic scenario is "install the latest CPython release", it could rather be done with pyenv install 3.

  1. Yes, looking back at the "Quick Start" it does stretch too much to be quick start. I will try to move the installation section and make it more concise.

  2. I admit I don't know what prefix resolution is. Which makes showing it nifty.

@madhu-GG
Reorganize readme, add gif
8c66f45 
1. Details in 'Getting Pyenv' and 'Setup for your shell' are collapsed. User can expand relevant
   sections depending on their platform and shell.

2. 'How It Works' and 'Advanced Configuration' are moved to the bottom of the README.md
   just before 'Contributing' section at the end.

3. Added a GIF in the 'Usage' section to showcase
   - Listing python versions available for install.
   - Installing a specific python version.
   - Listing installed python versions.
   - Switching to another python version for a directory.
   - Testing by moving terminal into the directory and moving back.
@madhu-GG madhu-GG force-pushed the master branch 2 times, most recently from e650e68 to b28e68a Compare October 13, 2024 12:17
@madhu-GG
Copy link
Contributor Author

@native-api Hey, I have incorporated the changes you mentioned. Please let me know if it requires further changes.

Changes brief:

  1. I updated the GIF to showcase the prefix resolution and moved it inside the Usage section.
  2. I have removed the 'Quick Start' section that I introduced, and instead moved the existing installation and usage sections towards the top just after the Table of Contents.
  3. The 'How it works' and 'Advanced configuration' have been moved to the bottom just before 'Contributing' section.
  4. Within the Installation and Usage sections
  • I have collapsed the details for each platform + shell. This way, the user only needs to expand the sections relevant to their platform and shell.
  • I have also updated numbering and added horizontal divider lines to make these two sections more readable.

@native-api
Copy link
Member

There are conflicts with master

@madhu-GG
Copy link
Contributor Author

There are conflicts with master

Yeah I will fix those and push my changes.

@madhu-GG
Copy link
Contributor Author

There are conflicts with master

resolved.

native-api
native-api approved these changes Oct 28, 2024
View reviewed changes
Copy link
Member

@native-api native-api left a comment

Choose a reason for hiding this comment

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

Okay, these are... pretty compact!
The interactive elements may confuse someone, but I think we can give this a whirl!
I hope you don't mind being CC'ed for any relevant feedback from users?

native-api
native-api reviewed Oct 28, 2024
View reviewed changes
native-api
native-api reviewed Oct 28, 2024
View reviewed changes
@native-api native-api merged commit 707e8d1 into pyenv:master Nov 20, 2024
17 checks passed
@native-api
Copy link
Member

Thank you very much for your contribution! 🎉

@BrewTestBot BrewTestBot mentioned this pull request Nov 20, 2024
Merged
@madhu-GG
Copy link
Contributor Author

Okay, these are... pretty compact! The interactive elements may confuse someone, but I think we can give this a whirl! I hope you don't mind being CC'ed for any relevant feedback from users?

Sorry for the late reply. Sure I will be happy to reply. Although I guess I have to come back here more often.

@madhu-GG
Copy link
Contributor Author

Thank you very much for your contribution! 🎉

Thanks for the encouragement. I do want to continue contributing, even if very seasonally.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@native-api native-api native-api 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.

Better quickstart guide/opening picture
2 participants
@madhu-GG @native-api