Skip to content

Commit

Permalink
doc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
sliepie committed Nov 8, 2018
1 parent 6bd456a commit cccc836
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 10 deletions.
6 changes: 3 additions & 3 deletions help/markdown/fake-commandline.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Fake Build Options [build_opts]:
-f, --script <script.fsx>
The script to execute (defaults to `build.fsx`).
```
Please refer to the [Fake.Core.CommandLineParsing documentation](core-commandlineparsing.html) for a explanation of the synax.
Please refer to the [Fake.Core.CommandLineParsing](core-commandlineparsing.html) documentation for a explanation of the synax.
For now fake only supports the `run` and `build` subcommands which are basically equivalent to the Fake as you know it, but more are planned in the future. In general you should use the `run` subcommand in scripting when you use parameters, because it is safer in regards to adding options without breaking. Use `build` to have a more dense workflow in the command line
Expand All @@ -59,7 +59,7 @@ Currently Fake supports 4 verbosity levels:
### `--version`
Print FAKE version information.
Prints FAKE version information.
### `--help`
Expand Down Expand Up @@ -94,7 +94,7 @@ Display CLI help.
## Running Targets
Please refer to the [target module documentation](core-targets.html)
Please refer to the [Fake.Core.Target](core-targets.html) module documentation
For reference the CLI for the targets-module looks like this:
Expand Down
12 changes: 5 additions & 7 deletions help/markdown/fake-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The Fake template bootstraps FAKE and sets up a basic build-script.

## Installation

Run
Run
<pre><code class="lang-bash">
dotnet new -i "fake-template::*"
</code></pre>
Expand All @@ -19,7 +19,7 @@ This will create a default `build.fsx` file, a `paket.dependencies` file used to
<pre><code class="lang-bash">
.\fake.cmd build
</code></pre>
to run your build. Have a look [this](fake-commandline.html) for the available command-line options. [This page](fake-gettingstarted.html#Example-Compiling-and-building-your-NET-application) additional information on how to use a build script.
to run your build. Have a look at the [fake commandline](fake-commandline.html) for the available command-line options. For additional information on how to use a build script, checkout the [getting started](fake-gettingstarted.html#Example-Compiling-and-building-your-NET-application) page.

## Options

Expand All @@ -29,7 +29,7 @@ Specifies the name of the generated build-script. Defaults to `build.fsx`.
### --bootstrap
Specifies your prefered way to bootstrap FAKE.

- `tool` (default) - Installs the FAKE dotnet sdk global tool into the `tool--path` folder
- `tool` (default) - Installs the FAKE dotnet sdk global tool into the `--tool-path` folder
- `project` - Creates a `build.proj` and uses `DotNetCliToolReference` to bootstrap FAKE
- `none` - Does not bootstrap FAKE. Use this if you want to use a global installation of FAKE

Expand All @@ -40,10 +40,8 @@ Specifies your prefered way to define the nuget packages used in your build:
- `inline` - Defines build dependencies inside the build script
- `none` - Use this if you already have a `paket.dependencies` in your folder

### --tool-path
Specifies the folder for the fake-cli tool. This parameter is only applicable when `tool` is used for bootstrapping. Defaults to `.fake`.
### --tool-path
Specifies the folder for the fake-cli tool. This parameter is only applicable when `tool` option is used for bootstrapping with `--bootstrap`. Defaults to `.fake`.

### --version
Specifies the version of FAKE to install. Defaults to `5.*`. This parameter is only applicable when either `tool` or `project` is used for bootstrapping.


0 comments on commit cccc836

Please sign in to comment.