Christian Fredrik Johnsen
c2554fc885
docs: add documentation to Advanced Configuration
section.
...
Tell users that `pyenv init -` works, but that specifying the shell
which is used is preferable, as it reduces launch time.
2024-12-21 18:05:48 +01:00
Christian Fredrik Johnsen
66a5c14622
docs: Recommend users to specify the shell they are using.
...
- Local testing shows that you get a trivial 1.6x speedup in command execution
time (over doing `pyenv init -`) by specifying which shell you are using.
2024-12-21 18:05:48 +01:00
Ivan Pozdeev
aef6a2a6d0
Remove incorrect statement about resolution behavior
...
`shell` does not fall through to `local`, and `local to `global`.
2024-12-15 21:20:49 +03:00
native-api
527d8fab3e
Adjust suggested shell startup code to support Pyenv with Pyenv-Win in WSL ( #3132 )
...
There's a complaint that this results in duplicate PATH entries in nested shells, will deal with that separately
2024-12-15 17:22:51 +03:00
Oluf Lorenzen
a2ad48aa40
README: explain using multiple versions ( #3126 )
...
Co-authored-by: native-api <vano@mail.mipt.ru>
2024-12-12 06:58:02 +03:00
Clément Vannicatte
6140619301
README: correct link to shell setup instructions ( #3113 )
2024-11-27 23:30:12 +03:00
Noelle Leigh
61c0f25ef5
README: Fix Markdown in "Notes about python releases" ( #3112 )
...
HTML and Markdown need to be separated by an empty line to co-exist, otherwise the Markdown isn't parsed correctly.
2024-11-23 16:35:06 +03:00
Madhu Gururajan
707e8d1ef8
Add quick start section and gif demo to accompany it. ( #3044 )
...
* Reorganize readme, add gif
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.
* Update GIF to show prefix resolution
* Collapse upgrade notes
* Cross-mention Linux and MacOS instlalation scenarios
---------
Co-authored-by: Ivan Pozdeev <vano@mail.mipt.ru>
2024-11-20 22:08:35 +03:00
Ivan Pozdeev
3f2ef9e00a
README: Clarify Zsh configuration
...
Closes #3069
2024-09-28 21:04:59 +03:00
ThomasHaz
88f76ee787
README: Remove reference to Fig [ https://fig.io ] ( #3018 )
...
[Fig](https://fig.io ) has been sunlit for new users, with access being removed in September
2024-07-20 21:32:57 +03:00
Ivan Pozdeev
cb99cbcc8e
README: Emphasize the main design idea of the plugins
2024-06-09 00:01:20 +03:00
native-api
4ab9b3710b
Document PYTHON_BUILD_CURL_OPTS, PYTHON_BUILD_WGET_OPTS, PYTHON_BUILD_ARIA2_OPTS ( #2976 )
...
[no ci]
2024-06-02 15:24:00 +03:00
Younes Askour
8a464cfed1
Correct the Explanation of PATH Variable Lookup ( #2975 )
...
This PR corrects a small but important detail in the documentation regarding how the system searches for executable files. The original text incorrectly stated that the operating system performs this search. The corrected text clarifies that it is actually the shell that performs the search.
2024-06-01 22:13:57 +03:00
native-api
8f8a5e03b4
Better document installing the HEAD version with Homebrew
2024-02-15 22:40:53 +03:00
Ryan Williams
920d8d4dbe
Make "Automatic installer" command a copy-able code block ( #2874 )
2023-12-30 18:11:56 +03:00
native-api
087793a660
Make adding $PYENV_ROOT/bin to PATH independent of other software ( #2837 )
...
Fixes breakage in WSL with Pyenv-win installed in the host system;
doesn't affect other supported installation scenarios.
2023-11-12 11:58:17 +03:00
Meng Xiangzhuo
3ba8df29e5
fix a typo in README.md
2023-08-29 16:45:11 +08:00
VictorieeMan
8aabba9485
README: Add explicit UNIX reference into the relevant installation sections ( #2744 )
...
Co-authored-by: Ivan Pozdeev <vano@mail.mipt.ru>
2023-07-23 22:29:17 +03:00
Ivan Pozdeev
a57e0b5019
README: move troubleshooting note higher
2023-04-16 20:11:08 +03:00
Ivan Pozdeev
5a8dbcf143
Document using and writing plugins
2023-04-07 19:07:35 +03:00
Ivan Pozdeev
6052caa038
README: extended support for 3.5.10
2023-03-02 11:27:23 +03:00
Michael Rienstra
ecab7b0d17
README: clarify behavior of pyenv latest
2023-02-27 16:26:18 -08:00
Ivan Pozdeev
1a0b555baf
Improve visibility of the auto-resolution feature
...
Recent feedback showed that it's not visible enough
2023-01-22 00:07:53 +03:00
Brendan Falk
25c974d59a
Add Fig as autocomplete suggestion ( #2574 )
...
Co-authored-by: Ivan Pozdeev <vano@mail.mipt.ru>
2023-01-05 05:03:45 +03:00
hauntsaninja
03ee3ffd32
Mention how to build for maximum performance
2023-01-02 14:35:16 -08:00
spookyuser
4971d9e35e
Copy auto installer oneliner to README ( #2538 )
2022-11-29 23:00:22 +03:00
weensy
6d13db992f
Fix typo in README.md ( #2535 )
...
There was a space at the beginning of the `git clone` command
2022-11-28 19:43:11 +03:00
Ivan Pozdeev
904fe964b0
README: Prefix auto-resolution: improve phrasing
2022-11-07 04:46:44 +03:00
Ivan Pozdeev
e03118235a
Improve prefix resolution documentation
2022-10-30 21:38:06 +03:00
Ivan Pozdeev
4a031504db
Document prefix auto-resolution et al.
...
* Document listing available versions in the tutorial (#1677 )
* Reflect 3.7.15's extended support
* Document using development head with Homebrew
* Structurize the Upgrading section
* Fix Pyenv-latest documentation
2022-10-30 05:28:53 +03:00
native-api
c5e0d2cd94
Document extended support for 3.7.14
...
Added in https://github.com/pyenv/pyenv/pull/2463
2022-09-15 22:01:05 +03:00
Grzegorz
6a104f68d0
docs: Add configuration option for Fish 3.2.0+ ( #2449 )
...
The original instructions were added 2 years ago in 0f2d659732
. Since then, [Fish released](https://github.com/fish-shell/fish-shell/releases/tag/3.2.0 ) [a more declarative instruction for this operation](https://fishshell.com/docs/current/cmds/fish_add_path.html ), which is now the recommended way of manipulating `PATH` in Fish.
2022-09-06 21:39:31 +03:00
hardikpnsp
afeb971fa2
Add support for multiple versions in pyenv uninstall
( #2432 )
2022-08-15 20:25:46 +03:00
Janith Petangoda
ae22c69505
Small update to instruction in README.md ( #2431 )
2022-08-06 18:12:11 +03:00
native-api
d59e7dff5e
Update README.md
2022-06-11 01:14:46 +03:00
Ivan Pozdeev
e48883b940
README: document cases of extended support
2022-06-11 01:10:44 +03:00
Ivan Pozdeev
c4fd08e6fb
README: Link to CONTRIBUTING and Python-Build's envvars
2022-06-09 02:52:50 +03:00
SADIK KUZU
169321b3e6
README.md, CHANGELOG.md, libexec/pyenv-help: Fix typos
2022-05-08 09:46:47 +03:00
SADIK KUZU
86598fcf4e
README.md: Fix typo
2022-05-08 01:16:03 +03:00
Ivan Pozdeev
867f34b596
README.md: Fix typos, improve phrasing
2022-05-04 04:28:35 +03:00
Ivan Pozdeev
6d4365a696
Make pyenv init --path
usable as a pyenv init -
substitute
...
We're going to eliminate the need to mandatorily use `pyenv init --path`.
We can't delete it yet for backward compatibility.
Besides, there's one other use case for it: to enable shims but without
shell integration, e.g. for noninteractive shells.
To be a full-fledged replacement for `pyenv init -` however,
it needs to do rehashing.
2022-05-02 19:07:24 +03:00
Ivan Pozdeev
8439f8e187
Simplify init scheme; update & clarify the README
...
Now the setup is to add to both rc and profile:
1) set PYENV_ROOT
(can do it unconditionally -- since if you change it,
you need to update all places anyway since any of them can be run first)
2) Add `pyenv` to PATH if not already there
3) eval "$(pyenv init -)"
Not a breaking change, old setup will continue to work.
2022-05-02 19:07:24 +03:00
Ed Rogers
986fe1a749
Prevent GitHub autolinking to an issue ( #2282 )
2022-03-18 07:52:26 +03:00
John Miller
c80b1cdfb9
Fix errant "echo" in build env install instructions ( #2185 )
2021-12-08 07:12:53 +03:00
Ivan Pozdeev
a0cc289d15
Added a wiki page on how to setup shell as a login shell in MacOS
2021-10-27 00:27:14 +03:00
native-api
0388da7d0b
Add setup instructions for the case when one installs Pyenv as part of a batch job ( #2127 )
2021-10-25 01:08:57 +03:00
Khushl Vora
a015760854
Update README.md ( #2120 )
...
Minor changes to make the docs better.
2021-10-23 17:33:18 +03:00
native-api
0915c5b7b6
Update README.md
2021-10-16 01:57:05 +03:00
native-api
ed38af6409
Add Homerew alias to fix brew doctor
's warning
...
Closes #106
2021-10-15 22:15:25 +03:00
Marcin Konowalczyk
07aa659dbb
fish installation instructions ( #2104 )
2021-10-12 14:09:15 +03:00