Skip to content

Commit fec9c6b

Browse files
committed
Merge branch 'update-readme'
2 parents 6b4bfe1 + c56a4b7 commit fec9c6b

File tree

1 file changed

+13
-14
lines changed

1 file changed

+13
-14
lines changed

README.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ You'll *need* the following:
4242
* Ruby 1.9+ (to run the [x-api](https://github.com/exercism/x-api)).
4343
* Git 1.x
4444

45-
If you haven't already, please read our advice on [Git Workflow](http://help.exercism.io/git-workflow.html).
45+
If you haven't already, please read our advice on [Git Workflow](https://github.com/exercism/x-common/blob/master/CONTRIBUTING.md#maintaining-a-track).
4646

4747

4848
Here's one way to get setup:
@@ -60,11 +60,11 @@ Here's one way to get setup:
6060
rackup
6161
```
6262

63-
If you want more details, check out the [x-api README](https://github.com/exercism/x-api).
63+
If you want more details, check out the [x-api README](https://github.com/exercism/x-api/blob/master/README.md).
6464

6565
2. **Configure your exercism CLI to point to that x-api.** Out of the box, the CLI is configured to point to the production instances of the API (for account-specific data) and X-API (for problem data). You need to configure your CLI to point to the X-API instance you stood up in the prior step.
66-
67-
If you haven't already, you'll need need to [install the CLI](http://help.exercism.io/installing-the-cli.html).
66+
67+
If you haven't already, you'll need need to [install the CLI](http://exercism.io/cli).
6868

6969
```
7070
cd ~
@@ -80,7 +80,7 @@ If you want more details, check out the [x-api README](https://github.com/exerci
8080
If things are properly setup:
8181
* `exercism debug` output will include "`XAPI: http://localhost:9292 [connected]`"
8282
* `tree java` will look something like this:
83-
83+
8484
```
8585
java
8686
└── bob
@@ -101,7 +101,7 @@ If you want more details, check out the [x-api README](https://github.com/exerci
101101
git clone [email protected]:jtigger/xjava.git
102102
git remote add upstream https://github.com/exercism/xjava.git
103103
git pull --rebase upstream/master
104-
cd ~/workspace/exercism/x-api/problems
104+
cd ~/workspace/exercism/x-api/tracks
105105
rm -rf java
106106
ln -s ../../xjava java
107107
```
@@ -169,7 +169,7 @@ If you `exercism fetch` after doing a build, the CLI will fail with the followin
169169
```
170170
$ exercism fetch java bob
171171
2015/09/06 15:03:21 an internal server error was received.
172-
Please file a bug report with the contents of 'exercism debug' at: https://github.com/exercism/exercism.io/issues
172+
Please file a bug report with the contents of 'exercism debug' at: https://github.com/exercism/exercism.io/issues
173173
```
174174

175175
and if you review the logs of your x-api, you'll find:
@@ -195,31 +195,30 @@ First of all... Exercism is meant help programmers, world-wide, to develop their
195195
Before you submit a pull request, please ensure:
196196

197197
- the test suite covers the essential parts of the problem and interesting corner cases.
198-
- your example solution represents your best attempt at exemplary code.
199198
- the build script (`./bin/build.sh`) compiles and tests your code successfully.
200199

201200

202201
### Doing the Commit Dance
203202
*(These instructions assume you setup your development environment using the instructions above.)*
204203

205204
1. **Run the build script, locally.**
206-
205+
207206
```
208207
cd ~/workspace/exercism/xjava
209208
./bin/build.sh
210209
```
211210

212211
verify that the script runs successfully.
213-
212+
214213
2. **Fetch the problem from your local x-api, using the CLI.**
215214

216215
```
217216
cd ~/workspace/exercism/exercises
218217
exercism fetch java <problem-slug>
219218
```
220-
219+
221220
verify that the fetched problem does *not* contain any files not needed for the problem.
222-
221+
223222
3. **Run the tests against the example source.**
224223

225224
```
@@ -229,12 +228,12 @@ Before you submit a pull request, please ensure:
229228
```
230229

231230
verify that all tests pass.
232-
231+
233232
If you've successfully navigated to this point, you're ready to make that pull request!
234233

235234
### Making the Pull Request
236235

237-
Hopefully you've read our [Git Workflow](http://help.exercism.io/git-workflow.html) and done your work on a clone of a fork of the exercism xjava repo.
236+
Hopefully you've read our [Git Workflow](https://github.com/exercism/x-common/blob/master/CONTRIBUTING.md#maintaining-a-track) and done your work on a clone of a fork of the exercism xjava repo.
238237

239238
After you've pushed your changes to your fork (best done on a branch, remember), it's a matter of going to GitHub and submitting a pull request.
240239

0 commit comments

Comments
 (0)