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

feat: default environment tutorial #75

Merged
merged 4 commits into from
Nov 13, 2024

Conversation

zmitchell
Copy link
Member

No description provided.

@floxbot floxbot added the documentation Improvements or additions to documentation label Nov 12, 2024
Copy link

@zmitchell zmitchell force-pushed the zmitchell/default-env-tutorial branch from 4d10b48 to 9d2ba1e Compare November 12, 2024 19:48
@zmitchell zmitchell force-pushed the zmitchell/default-env-tutorial branch from 9d2ba1e to 30a681d Compare November 12, 2024 19:49
Copy link

Copy link

Copy link

Copy link

@zmitchell zmitchell merged commit 482e226 into preview Nov 13, 2024
2 checks passed
@zmitchell zmitchell deleted the zmitchell/default-env-tutorial branch November 13, 2024 16:53

In the typical development case you would create a directory for your project,
`flox init` to create an environment for it,
then `flox activate` in that directory when you want to work on that project.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
then `flox activate` in that directory when you want to work on that project.
and then `flox activate` in that directory when you want to work on that project.

Comment on lines +97 to +100
```bash
# Create and enter a new temporary directory
$ cd $(mktemp -d)
```
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: not sure if this command be helpful for teaching the concept, but it felt a tad contrived to me. It feels like it's going out of the way to say "you probably Flox to work in a different directory, and you're right, Flox doesn't fail in a way you don't expect it to fail"

Comment on lines +115 to +118
Depending on when you created your default environment
(the default was changed recently),
you may also see `flox [default]` as part of your prompt for every new shell.
You can configure that with a single command:
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: are you going to come back and change this in 2 weeks? It's going to get stale fast

Copy link
Member Author

Choose a reason for hiding this comment

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

I don't know about 2 weeks, but at some point yes I will change it

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants