Skip to content

Update README to focus on Codespace usage instructions#11

Open
ShreyasKhandekar wants to merge 1 commit intochapel-lang:mainfrom
ShreyasKhandekar:update-readme-for-codespace
Open

Update README to focus on Codespace usage instructions#11
ShreyasKhandekar wants to merge 1 commit intochapel-lang:mainfrom
ShreyasKhandekar:update-readme-for-codespace

Conversation

@ShreyasKhandekar
Copy link
Copy Markdown
Contributor

Since #9 opens the README by default and we expect users to land directly inside codespaces by using the https://codespaces.new/chapel-lang/chapel-hello-world link, we don't need the README to have instructions on how to launch a codespace.

This PR changes the README to focus on running the examples and pointers to other resources.

Signed-off-by: Shreyas Khandekar <60454060+ShreyasKhandekar@users.noreply.github.com>
Comment thread README.md

For more code samples, consider trying out the [Primers](https://chapel-lang.org/docs/primers/),
or the [many programs from a past Chapel tutorial](https://github.com/chapel-lang/chapel/tree/main/test/exercises/Oct2023tutorial).
## Compile And Run In The Terminal
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Suggested change
## Compile And Run In The Terminal
## Compile And Run With The Run Button In Codespaces VS Code
1. Open [hello.chpl](hello.chpl).
2. Wait for the Chapel extension and language tools to finish loading in Codespaces.
3. Click the Run button in the editor (top-right) to first compile and again run the current file.
If the Run button does not appear right away, wait a bit longer and reopen the `.chpl` file.
## Compile And Run In The Terminal

@bradcray suggested we put instructions for using the play button in the VSCode editor. This is an example of how we'd do that if we wanted to.

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.

1 participant