Skip to content

Commit 25369dc

Browse files
committed
README: Improve description of helloworld task
Improve description of task to create Markdown file from PDF contents. Signed-off-by: Razvan Deaconescu <[email protected]>
1 parent 82ae659 commit 25369dc

File tree

1 file changed

+15
-12
lines changed

1 file changed

+15
-12
lines changed

README.md

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -177,11 +177,17 @@ Create the `helloworld.md` file that will generate that precise GitHub view.
177177
Make sure you do the following:
178178

179179
1. Start by creating a branch where you do your work.
180+
Use `helloworld` for the branch name:
181+
182+
```console
183+
git checkoout -b helloworld
184+
```
185+
180186
This will be the branch **from** where you will create a pull request.
181187
As usual, the future pull request will target your assigned branch in the [upstream repository](https://github.com/rosedu/workshop-markdown).
182188

183189
1. Copy-paste contents from the PDF file.
184-
Do not write programs by hand.
190+
Open the `helloworld-print.pdf` file in a PDF viewer, select text, copy in the `helloworld.md` file.
185191

186192
1. Use correct syntax items for typewriter format, links to sections, code snippet format, tables.
187193
See [the GitHub Markdown spec](https://github.github.com/gfm/).
@@ -195,21 +201,18 @@ Make sure you do the following:
195201

196202
After each push, check the GitHub view of the work branch in your fork of the GitHub repository.
197203

198-
1. After completing the task, submit the `helloworld.md` Markdown file as part of a pull request.
199-
200-
Follow the instructions above to create the pull request.
201-
Make sure you have good commit messages and a good pull request description.
204+
Check the contents of the `helloworld.md` file on your GitHub fork and see if it is now rendered correctly.
202205

203-
Target the pull request **to** your assigned branch.
206+
1. After completing the task, submit the `helloworld.md` Markdown file as part of a pull request.
204207

205-
Ask the instructors to review your pull request.
206-
Make updates as required.
207-
Have your pull request approved and merged on top of your assigned branch.
208+
Follow the instructions above to create the pull request.
209+
Make sure you have good commit messages and a good pull request description.
208210

209-
Check the GitHub web view of the [upstream repository](https://github.com/rosedu/workshop-markdown) for your assigned branch.
210-
Click on the button with `main` (the branch button) and select your branch.
211+
Target the pull request **to** your assigned branch.
211212

212-
Check the contents of the `helloworld.md` file and see if it is now rendered correctly.
213+
1. Ask the instructors to review your pull request.
214+
Make updates as required.
215+
Have your pull request approved and merged on top of your assigned branch.
213216

214217
### Clean Up After Pull Request
215218

0 commit comments

Comments
 (0)