Merge pull request #610 from fthomas/topic/mv-running-steward

Move "Running scala-steward" section to docs/

README.md

@@ -29,6 +29,13 @@ look like, here are the ones it has created so far:
 * [Merged pull requests]( https://github.com/search?q=author%3Ascala-steward+is%3Amerged+sort%3Aupdated-desc)
  ([compact]( https://github.com/pulls?q=author%3Ascala-steward+is%3Amerged+sort%3Aupdated-desc))
 
+## Documentation
+
+The [`docs`](https://github.com/fthomas/scala-steward/tree/master/docs) directory
+contains documentation about these topics:
+
+* [Running scala-steward](https://github.com/fthomas/scala-steward/tree/master/docs/running.md)
+
 ## Contributors
 
 Thanks goes to these wonderful people:
@@ -82,49 +89,6 @@ and other Scala [libraries](https://github.com/fthomas/scala-steward/blob/master
 [**@scala-steward**][@scala-steward]'s cute profile picture is by
 [@impurepics](https://twitter.com/impurepics/).
 
-## Running scala-steward
-
-```bash
-sbt stage
-
-./modules/core/.jvm/target/universal/stage/bin/scala-steward \
- --workspace "$STEWARD_DIR/workspace" \
- --repos-file "$STEWARD_DIR/repos.md" \
- --git-author-name "Scala steward" \
- --git-author-email ${EMAIL} \
- --github-api-host "https://api.github.com" \
- --github-login ${LOGIN} \
- --git-ask-pass "$STEWARD_DIR/.github/askpass/$LOGIN.sh" \
- --sign-commits \
- --env-var FOO=BAR
-```
-
-Or,
-
-```bash
-sbt docker:publishLocal
-
-docker run -v $STEWARD_DIR:/opt/scala-steward -it scala-steward:0.1.0-SNAPSHOT \
- --workspace "/opt/scala-steward/workspace" \
- --repos-file "/opt/scala-steward/repos.md" \
- --git-author-name "Scala steward" \
- --git-author-email ${EMAIL} \
- --github-api-host "https://api.github.com" \
- --github-login ${LOGIN} \
- --git-ask-pass "/opt/scala-steward/.github/askpass/$LOGIN.sh" \
- --sign-commits \
- --env-var FOO=BAR
-```
-
-If you run scala-steward for your own private projects, you can pass additional environment variables from the command line using the `--env-var` flag as shown in the examples above. You can use this to pass any credentials required by your projects to resolve any private dependencies, e.g.: 
-
-```bash
---env-var BINTRAY_USER=username \
---env-var BINTRAY_PASS=password
-```
-
-These variables will be accessible (in sbt) to all of the projects that scala-steward checks dependencies for.
-
 ## License
 
 scala-steward is licensed under the

docs/running.md

@@ -0,0 +1,42 @@
+## Running scala-steward
+
+```bash
+sbt stage
+
+./modules/core/.jvm/target/universal/stage/bin/scala-steward \
+ --workspace "$STEWARD_DIR/workspace" \
+ --repos-file "$STEWARD_DIR/repos.md" \
+ --git-author-name "Scala steward" \
+ --git-author-email ${EMAIL} \
+ --github-api-host "https://api.github.com" \
+ --github-login ${LOGIN} \
+ --git-ask-pass "$STEWARD_DIR/.github/askpass/$LOGIN.sh" \
+ --sign-commits \
+ --env-var FOO=BAR
+```
+
+Or,
+
+```bash
+sbt docker:publishLocal
+
+docker run -v $STEWARD_DIR:/opt/scala-steward -it scala-steward:0.1.0-SNAPSHOT \
+ --workspace "/opt/scala-steward/workspace" \
+ --repos-file "/opt/scala-steward/repos.md" \
+ --git-author-name "Scala steward" \
+ --git-author-email ${EMAIL} \
+ --github-api-host "https://api.github.com" \
+ --github-login ${LOGIN} \
+ --git-ask-pass "/opt/scala-steward/.github/askpass/$LOGIN.sh" \
+ --sign-commits \
+ --env-var FOO=BAR
+```
+
+If you run scala-steward for your own private projects, you can pass additional environment variables from the command line using the `--env-var` flag as shown in the examples above. You can use this to pass any credentials required by your projects to resolve any private dependencies, e.g.:
+
+```bash
+--env-var BINTRAY_USER=username \
+--env-var BINTRAY_PASS=password
+```
+
+These variables will be accessible (in sbt) to all of the projects that scala-steward checks dependencies for.