Skip to content

Commit c1f9ee4

Browse files
Updating hello-world instructions.append (#2787)
* Updating hello-world instructions.append * Changing dot for a comma * Update exercises/practice/hello-world/.docs/instructions.append.md Co-authored-by: Sander Ploegsma <sanderploegsma@gmail.com> * Update exercises/practice/hello-world/.docs/instructions.append.md Co-authored-by: Sander Ploegsma <sanderploegsma@gmail.com> * Apllying suggestions New sentences on new lines making consistent the urls * Fixing url duplication --------- Co-authored-by: Sander Ploegsma <sanderploegsma@gmail.com>
1 parent c43d39d commit c1f9ee4

File tree

1 file changed

+60
-63
lines changed

1 file changed

+60
-63
lines changed
Lines changed: 60 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,44 @@
11
# Instructions append
22

3-
Since this is your first Java exercise, we've included a detailed [Tutorial](#tutorial)
4-
that guides you through your solution. Check it out for tips and
5-
assistance!
3+
Since this is your first Java exercise, we've included a detailed [Tutorial] that guides you through your solution. Check it out for tips and assistance!
64

75
## Tutorial
86

97
### Table of Contents
108

11-
- [Introduction](#introduction)
12-
- [Exercise Structure](#exercise-structure)
13-
- [Solving "Hello, World!"](#solving-hello-world)
14-
- [Step 1: Fix the solution](#step-1-fix-the-solution)
15-
- [Step 2: Run the tests](#step-2-run-the-tests)
16-
- [Step 3: Submitting your first iteration](#step-3-submitting-your-first-iteration)
17-
- [Next steps](#next-steps)
9+
- [Introduction]
10+
- [Exercise Structure]
11+
- [Solving "Hello, World!"]
12+
- [Step 1: Fix the solution]
13+
- [Step 2: Run the tests]
14+
- [Step 3: Submitting your first iteration]
15+
- [Next steps]
1816

1917
### Introduction
2018

2119
Welcome to the first exercise on the Java track!
2220

23-
This document is a step-by-step guide to solving this exercise. The
24-
instructions should work equally well on Windows, macOS and Linux.
21+
This document is a step-by-step guide to solving this exercise.
22+
The instructions should work equally well on Windows, macOS and Linux.
2523

26-
Even if you are already familiar with Java basics, stepping through this guide
27-
may be helpful as it will help you understand the output from the tool, Gradle,
28-
that we use to compile and test our code, as well as introduce some of the
29-
patterns common to all exercises in this track.
24+
Even if you are already familiar with Java basics, stepping through this guide may be helpful as it will help you understand the output from the tool, Gradle, that we use to compile and test our code, as well as introduce some of the patterns common to all exercises in this track.
3025

3126
### Exercise Structure
3227

3328
When you fetch a new Java exercise, you will receive:
3429

35-
- __one or more test files__ (always). These live in the `src/test/java`
36-
directory and define a set of tests that our solution must satisfy before we
37-
can safely declare that it is working.
38-
- __one or more starter files__ (initially). If provided, these live in the
39-
`src/main/java` directory and define shells of the classes you will need
40-
in order to solve the current problem.
30+
- __one or more test files__ (always).
31+
These live in the `src/test/java` directory and define a set of tests that our solution must satisfy before we can safely declare that it is working.
32+
- __one or more starter files__ (initially).
33+
If provided, these live in the `src/main/java` directory and define shells of the classes you will need in order to solve the current problem.
4134

4235
### Solving "Hello, World!"
4336

44-
You can use our online editor to solve your solution and run the tests, but
45-
if you want to solve the problem and run tests locally check these links below:
37+
You can use our online editor to solve your solution and run the tests, but if you want to solve the problem and run tests locally check these links below:
4638

47-
- [Installing Java and Gradle](https://exercism.org/docs/tracks/java/installation)
48-
- [Working Locally](https://exercism.org/docs/using/solving-exercises/working-locally)
49-
- [Testing locally on the java track](https://exercism.org/docs/tracks/java/tests)
39+
- [Installing Java]
40+
- [Working Locally]
41+
- [Testing locally on the java track]
5042

5143
### Step 1: Fix the solution
5244

@@ -66,73 +58,78 @@ After making corrections and implementing your solution, run the tests again.
6658
You can run the tests using the online editor or locally on your machine:
6759

6860
- To run the tests in the online editor, click the "Run Tests" button.
69-
- To run the tests locally, check [Testing on the Java track](https://exercism.org/docs/tracks/java/tests)
70-
If the tests fails, that's ok! See what the error message is telling you, change your code and test again.
71-
When your tests pass, move on to the next step.
61+
- To run the tests locally, check [Testing on the Java track][Testing locally on the java track] If the tests fails, that's ok! See what the error message is telling you, change your code and test again, when your tests pass, move on to the next step.
7262

7363
### Step 3: Submitting your first iteration
7464

75-
With a working solution that we've reviewed, we're ready to submit it to
76-
exercism.org.
77-
You can submit the solution using the online editor or locally using the [Exercism CLI](https://exercism.org/docs/using/solving-exercises/working-locally):
65+
With a working solution that we've reviewed, we're ready to submit it to exercism.org.
66+
You can submit the solution using the online editor or locally using the [Exercism CLI][Working Locally]:
7867

79-
- To submit the exercise locally, first [install the exercism CLI](https://exercism.org/docs/using/solving-exercises/working-locally) if you haven't already and then submit the files of your solution, e.g:
68+
- To submit the exercise locally, first [install the exercism CLI][Working Locally] if you haven't already and then submit the files of your solution, e.g:
8069

81-
```sh
82-
exercism submit <file location>
83-
```
70+
```sh
71+
exercism submit <file location>
72+
```
8473

85-
replace `<file location>` with the relative location of your hello-world.java file.
86-
so if you are working in "C:\exercism\java\hello-world" then the command would be
74+
- Replace `<file location>` with the relative location of your `Greeter.java` file, so if you are working in `C:\exercism\java\hello-world` then the command would be
8775

88-
```sh
89-
exercism submit .\src\main\java\Blackjack.java
90-
```
76+
```sh
77+
exercism submit .\src\main\java\Greeter.java
78+
```
9179

9280
- If you want to use the online editor to submit your solution, just click the "Submit" button!
9381

9482
For a closer look at submitting a solution locally:
9583

96-
- [Submitting locally](https://exercism.org/docs/using/solving-exercises/working-locally);
84+
- [Submitting locally][Working Locally]
9785

9886
### Next steps
9987

10088
From here, there are a number of paths you can take.
10189

102-
Regardless of what you decide to do next, we sincerely hope you learn
103-
and enjoy being part of this community. If at any time you need assistance
104-
do not hesitate to ask for help.
90+
Regardless of what you decide to do next, we sincerely hope you learn and enjoy being part of this community.
91+
If at any time you need assistance do not hesitate to ask for help.
10592

10693
Cheers!
10794

10895
### Move on to the next exercise
10996

110-
There are many more exercises you can practice with. Grab the next one! (example for `two-fer`)
97+
There are many more exercises you can practice with.
98+
Grab the next one! (example for `two-fer`)
11199

112100
```sh
113101
exercism download --exercise=two-fer --track=java
114102
```
115103

116104
### Become a mentor
117105

118-
The heart of Exercism are the conversations about coding
119-
practices. It's definitely fun to practice, but engaging with others
120-
both in their attempts and your own is how you get feedback. That feedback
121-
can help point out what you're doing well and where you might need to
122-
improve.
106+
The heart of Exercism are the conversations about coding practices.
107+
It's definitely fun to practice, but engaging with others both in their attempts and your own is how you get feedback.
108+
That feedback can help point out what you're doing well and where you might need to improve.
123109

124-
Some submissions will be nearly identical to yours; others will be
125-
completely different. Seeing both kinds can be instructive and interesting.
110+
Some submissions will be nearly identical to yours, others will be completely different.
111+
Seeing both kinds can be instructive and interesting.
126112

127-
Mentors review submitted solutions for the track they've chosen to mentor
128-
to help users learn as much as possible. To read more about mentoring and
129-
to sign up see: <http://mentoring.exercism.io/>.
113+
Mentors review submitted solutions for the track they've chosen to mentor to help users learn as much as possible.
130114

131-
### Contribute to Exercism
132-
133-
The entire of Exercism is Open Source and is a labor of love for over
134-
100 maintainers and many more contributors.
115+
To read more about mentoring, go to the following [link][Mentoring].
135116

136-
A starting point to jumping in can be found here:
117+
### Contribute to Exercism
137118

138-
<https://github.com/exercism/docs/tree/main/building>
119+
The entire of Exercism is Open Source and is a labor of love for over 100 maintainers and many more contributors.
120+
121+
A starting point to jumping in and becoming a contributor can be found [here][Contributing].
122+
123+
[Tutorial]: #tutorial
124+
[Introduction]: #introduction
125+
[Exercise Structure]: #exercise-structure
126+
[Solving "Hello, World!"]: #solving-hello-world
127+
[Step 1: Fix the solution]: #step-1-fix-the-solution
128+
[Step 2: Run the tests]: #step-2-run-the-tests
129+
[Step 3: Submitting your first iteration]: #step-3-submitting-your-first-iteration
130+
[Next steps]: #next-steps
131+
[Mentoring]: https://exercism.org/docs/mentoring
132+
[Contributing]: https://github.com/exercism/docs/tree/main/building
133+
[Installing Java]: https://exercism.org/docs/tracks/java/installation
134+
[Working Locally]: https://exercism.org/docs/using/solving-exercises/working-locally
135+
[Testing locally on the java track]: https://exercism.org/docs/tracks/java/tests

0 commit comments

Comments
 (0)