Skip to content

Commit

Permalink
more badges and smaller doc adjustments
Browse files Browse the repository at this point in the history
  • Loading branch information
matthid committed Aug 12, 2018
1 parent 59c2a76 commit da4bacf
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 14 deletions.
5 changes: 3 additions & 2 deletions README.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ Visual Studio or MonoDevelop, which provide syntax highlighting and code complet

The new DSL was designed to be succinct, typed, declarative, extensible and easy to use.

See the [project home page](http://fsharp.github.com/FAKE/) for tutorials and [API documentation](http://fsharp.github.io/FAKE/apidocs/v5/index.html).
See the [project home page](https://fake.build/) for tutorials and [API documentation](http://fake.build/apidocs/v5/index.html).

# Build the project

* Quick: Download and install the [Dotnet SDK](https://www.microsoft.com/net/learn/get-started) and run `dotnet build build.proj`
* Fake5: Install FAKE 5 (for example via `choco install fake -pre`) and run `fake build`

[![Travis build status](https://travis-ci.org/fsharp/FAKE.png)](https://travis-ci.org/fsharp/FAKE)
[![AppVeyor build status](https://ci.appveyor.com/api/projects/status/lk1dfo1qi99ri78f)](https://ci.appveyor.com/project/SteffenForkmann/fake)
[![AppVeyor build status](https://ci.appveyor.com/api/projects/status/lk1dfo1qi99ri78f)](https://ci.appveyor.com/project/SteffenForkmann/fake) [![CircleCI build status](https://circleci.com/gh/fsharp/FAKE.svg?style=shield&circle-token=:circle-token)](https://circleci.com/gh/fsharp/FAKE) [![Gitlab CI build status](https://gitlab.com/matthid/FAKE/badges/release/next/build.svg)](https://gitlab.com/matthid/FAKE)

> Note: The build of the "legacy" parts (FAKE 4) will most likely fail
>
Expand All @@ -32,6 +32,7 @@ Otherwise the test-suite will fail (However, the compilation should work)
[![Issue Stats](http://www.issuestats.com/github/fsharp/FAKE/badge/pr)](http://www.issuestats.com/github/fsharp/FAKE) [![Issue Stats](http://www.issuestats.com/github/fsharp/FAKE/badge/issue)](http://www.issuestats.com/github/fsharp/FAKE)

[![NuGet Badge](https://buildstats.info/nuget/FAKE)](https://www.nuget.org/packages/FAKE)
[![NuGet Badge](https://buildstats.info/nuget/Fake.Core.Target)](https://www.nuget.org/packages/Fake.Core.Target) [![NuGet Badge](https://buildstats.info/nuget/Fake.Core.Context)](https://www.nuget.org/packages/Fake.Core.Context)

## How to contribute code

Expand Down
21 changes: 9 additions & 12 deletions help/markdown/fake-gettingstarted.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,17 +62,14 @@ There are various ways to install FAKE 5:
Once `fake` is available you can start creating your script:

* Create a new file `myscript.fsx` with the following contents:
```fsharp
#r "paket:
nuget Fake.Core.Target prerelease"
#load "./.fake/myscript.fsx/intellisense.fsx"
```
<div class="alert alert-info">
<h5>INFO</h5>
<p><code>storage: none</code> is currently required because of a bug, but it will be added by default.</p>
</div>

Where you can add all the [fake modules](fake-fake5-modules.html) you need.
```fsharp
#r "paket:
nuget Fake.Core.Target prerelease"
#load "./.fake/myscript.fsx/intellisense.fsx"
```

Where you can add all the [fake modules](fake-fake5-modules.html) you need.

* run the script to restore your dependencies and setup the intellisense support: `fake run myscript.fsx`.
This might take some seconds depending on your internet connection
Expand Down Expand Up @@ -223,7 +220,7 @@ let buildDir = "./build/"
// Targets
Target.create "Clean" (fun _ ->
Shell.CleanDir buildDir
Shell.cleanDir buildDir
)
Target.create "BuildApp" (fun _ ->
Expand Down Expand Up @@ -279,7 +276,7 @@ let testDir = "./test/"
// Targets
Target.create "Clean" (fun _ ->
Shell.CleanDirs [buildDir; testDir]
Shell.cleanDirs [buildDir; testDir]
)
Target.create "BuildApp" (fun _ ->
Expand Down

0 comments on commit da4bacf

Please sign in to comment.