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

Update README.md about local env #587

Merged
merged 7 commits into from
Sep 1, 2023
Merged

Update README.md about local env #587

merged 7 commits into from
Sep 1, 2023

Conversation

pamelafox
Copy link
Collaborator

Purpose

This PR tries to clarify the environment setup and changes the section heading to distinguish between Local environment and Running the app locally.

Does this introduce a breaking change?

[ ] Yes
[X] No

Pull Request Type

What kind of change does this Pull Request introduce?

[ ] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[X] Documentation content changes
[ ] Other... Please describe:

Copy link
Collaborator

@charris-msft charris-msft left a comment

Choose a reason for hiding this comment

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

I think putting the Codespaces option first will help people get up and running quickly so they can test it out and see if it suits their needs.

README.md Outdated
@@ -79,16 +99,7 @@ either by deleting the resource group in the Portal or running `azd down`.
* [Powershell 7+ (pwsh)](https://github.com/powershell/powershell) - For Windows users only.
* **Important**: Ensure you can run `pwsh.exe` from a PowerShell command. If this fails, you likely need to upgrade PowerShell.
Copy link
Collaborator

Choose a reason for hiding this comment

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

... from a PowerShell terminal. If this fails ...

README.md Outdated

#### VS Code Remote Containers

A related option is VS Code Remote Containers, which will open the container in your local VS Code:
Copy link
Collaborator

Choose a reason for hiding this comment

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

"open the container" - which container?
I'm personally not familiar with this

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Reworded to "A related option is VS Code Remote Containers, which will open the project in your local VS Code using the Dev Containers extension:"

@pamelafox pamelafox merged commit 62c5962 into main Sep 1, 2023
6 checks passed
HughRunyan pushed a commit to RMI/RMI_chatbot that referenced this pull request Mar 26, 2024
* Update README.md about local env

* Update README.md

* Update README.md

* Update README.md

* Update README.md with terminal

* Clarify VS Code remote
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.

3 participants