Explorar el Código

Merge branch 'update-readme'

John S. Ryan hace 10 años
padre
commit
fec9c6b77f
Se han modificado 1 ficheros con 13 adiciones y 14 borrados
  1. 13
    14
      README.md

+ 13
- 14
README.md Ver fichero

@@ -42,7 +42,7 @@ You'll *need* the following:
42 42
 * Ruby 1.9+  (to run the [x-api](https://github.com/exercism/x-api)).
43 43
 * Git 1.x
44 44
 
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).
46 46
 
47 47
 
48 48
 Here's one way to get setup:
@@ -60,11 +60,11 @@ Here's one way to get setup:
60 60
 	rackup
61 61
 	```
62 62
 
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).
64 64
 
65 65
 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).
68 68
 
69 69
 	```
70 70
 	cd ~
@@ -80,7 +80,7 @@ If you want more details, check out the [x-api README](https://github.com/exerci
80 80
 	If things are properly setup:
81 81
 	* `exercism debug` output will include "`XAPI: http://localhost:9292 [connected]`"
82 82
 	* `tree java` will look something like this:
83
-	
83
+
84 84
 		```
85 85
 		java
86 86
 		└── bob
@@ -101,7 +101,7 @@ If you want more details, check out the [x-api README](https://github.com/exerci
101 101
 	git clone git@github.com:jtigger/xjava.git
102 102
 	git remote add upstream https://github.com/exercism/xjava.git
103 103
 	git pull --rebase upstream/master
104
-	cd ~/workspace/exercism/x-api/problems
104
+	cd ~/workspace/exercism/x-api/tracks
105 105
 	rm -rf java
106 106
 	ln -s ../../xjava java
107 107
 	```
@@ -169,7 +169,7 @@ If you `exercism fetch` after doing a build, the CLI will fail with the followin
169 169
 ```
170 170
 $ exercism fetch java bob
171 171
 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
173 173
 ```
174 174
 
175 175
 and if you review the logs of your x-api, you'll find:
@@ -195,7 +195,6 @@ First of all... Exercism is meant help programmers, world-wide, to develop their
195 195
 Before you submit a pull request, please ensure:
196 196
 
197 197
 - 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. 
199 198
 - the build script (`./bin/build.sh`) compiles and tests your code successfully.
200 199
 
201 200
 
@@ -203,23 +202,23 @@ Before you submit a pull request, please ensure:
203 202
 *(These instructions assume you setup your development environment using the instructions above.)*
204 203
 
205 204
 1. **Run the build script, locally.**
206
- 
205
+
207 206
    ```
208 207
    cd ~/workspace/exercism/xjava
209 208
    ./bin/build.sh
210 209
    ```
211 210
 
212 211
    verify that the script runs successfully.
213
-   
212
+
214 213
 2. **Fetch the problem from your local x-api, using the CLI.**
215 214
 
216 215
    ```
217 216
    cd ~/workspace/exercism/exercises
218 217
    exercism fetch java <problem-slug>
219 218
    ```
220
-   
219
+
221 220
    verify that the fetched problem does *not* contain any files not needed for the problem.
222
-   
221
+
223 222
 3. **Run the tests against the example source.**
224 223
 
225 224
    ```
@@ -229,12 +228,12 @@ Before you submit a pull request, please ensure:
229 228
    ```
230 229
 
231 230
    verify that all tests pass.
232
-   
231
+
233 232
 If you've successfully navigated to this point, you're ready to make that pull request!
234 233
 
235 234
 ### Making the Pull Request
236 235
 
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.
238 237
 
239 238
 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.
240 239