Skip to content

Commit

Permalink
Merge branch 'master' of https://github.com/fsharp/FAKE
Browse files Browse the repository at this point in the history
  • Loading branch information
forki committed Oct 27, 2015
2 parents 87ca337 + de682c3 commit c15602c
Show file tree
Hide file tree
Showing 4 changed files with 57 additions and 2 deletions.
55 changes: 55 additions & 0 deletions help/gettingstarted.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,61 @@ If you run this batch file from the command line then the latest FAKE version wi

![alt text](pics/gettingstarted/afterdownload.png "Run the batch file")

### Paket Setup

Alternatively you can configure [Paket](http://fsprojects.github.io/Paket) to install and manage FAKE as a dependency. You will have to [setup Paket](http://fsprojects.github.io/Paket/installation.html) following the instructions specified in its documentation. In this example, the [installation per repository](http://fsprojects.github.io/Paket/installation.html#Installation-per-repository) will be used.

* Create a `.paket` folder in the root of the `FAKE-Calculator` solution.
* Download the latest [paket.bootstrapper.exe](https://github.com/fsprojects/Paket/releases/latest) into that folder.
* Run `$ .paket/paket.bootstrapper.exe` This will download the latest `paket.exe`.
* Commit `.paket/paket.bootstrapper.exe` into your repo and add `.paket/paket.exe` to your `.gitignore` file.

### Specifying dependencies

Create a [`paket.dependencies` file](http://fsprojects.github.io/Paket/dependencies-file.html) in your project's root and specify FAKE as a dependency in it.
The file might look like this:

source https://nuget.org/api/v2

nuget FAKE

You can now run Paket from the command line:

$ .paket/paket.exe install

This will create the [`paket.lock` file](http://fsprojects.github.io/Paket/lock-file.html) in your project's root. The file might look like this:

NUGET
remote: https://nuget.org/api/v2
specs:
FAKE (4.7.2)

You will have to replace the `build.bat` file contents with the following:

[lang=batchfile]
@echo off
cls

.paket\paket.bootstrapper.exe
if errorlevel 1 (
exit /b %errorlevel%
)

.paket\paket.exe restore
if errorlevel 1 (
exit /b %errorlevel%
)

packages\FAKE\tools\FAKE.exe build.fsx %*

If you run this batch file from the command line, Paket will be bootstrapped and the paket dependencies will be restored before running the build script.
In this case, then the latest FAKE version will be [downloaded via nuget](http://nuget.org/packages/FAKE/).
If everything works fine you will get the following output:

![alt text](pics/gettingstarted/afterdownloadpaket.png "Run the batch file")

### The build script

Now open the *build.fsx* in Visual Studio or any text editor. It should look like this:

// include Fake lib
Expand Down
Binary file added help/pics/gettingstarted/afterdownloadpaket.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion paket.lock
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ CONTENT: NONE
NUGET
remote: http://nuget.org/api/v2
specs:
FAKE (4.6.0)
FAKE (4.7.0)
FSharp.Compiler.Service (0.0.90)
FSharp.Formatting (2.11.0)
FSharp.Compiler.Service (>= 0.0.90 <= 1.3)
Expand Down
2 changes: 1 addition & 1 deletion src/app/FakeLib/UnitTest/ProcessTestRunner.fs
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ type ProcessTestRunnerParams =
/// Option which allows to specify if a test runner error should break the build.
ErrorLevel : TestRunnerErrorLevel }

/// The ProcessTestRunner defeaults.
/// The ProcessTestRunner defaults.
let ProcessTestRunnerDefaults =
{ WorkingDir = null
TimeOut = TimeSpan.FromMinutes 5.
Expand Down

0 comments on commit c15602c

Please sign in to comment.