Skip to content

Commit c33e72f

Browse files
committed
update readme
1 parent bf9888c commit c33e72f

File tree

1 file changed

+27
-55
lines changed

1 file changed

+27
-55
lines changed

README.md

Lines changed: 27 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,38 @@
1-
# The F# Language, Library, and Visual F# Tools Repository
1+
F# Compiler Service
2+
===================
23

3-
You are invited to help producing future releases of the F# language compiler, library, and tools. This repository enables development on Linux, macOS and Windows, along with some automated CI testing for these.
4+
The F# compiler services package contains a custom build of the F# compiler that
5+
exposes additional functionality for implementing F# language bindings, additional
6+
tools based on the compiler or refactoring tools. The package also includes F#
7+
interactive service that can be used for embedding F# scripting into your applications.
48

5-
* [About F#](http://fsharp.org)
6-
* [Testimonials](http://fsharp.org/testimonials)
7-
* [Contributing](#contributing)
8-
* [Using](#using)
9+
Documentation
10+
-------------
911

10-
The F# Compiler and Tools are also mirrored in [the corresponding repository](http://github.com/fsharp/fsharp) of the F# Software Foundation.
12+
For more information about the project, see:
1113

12-
Changes contributed here are eventually propagated to this repository and are included in all packagings of F# and open source F# editing tools. The process for doing this is explained in this guide by the [F# Core Engineering Group](https://fsharp.github.io/2014/06/18/fsharp-contributions.html). Currently, the F# community coordinates packaging [other editions of F#](https://github.com/fsharp/fsharp/) for use on Linux, macOS, Android, iOS, and other platforms, and Microsoft coordinates packaging this repository as part of the Visual F# Tools.
13-
14-
For historical reasons this repository is called "visualfsharp" and currently also contains the Visual F# IDE Tools. The eventual plan is to split these repositories into "fsharp" and "visualfsharp".
14+
* [F# Compiler Service documentation](http://fsharp.github.io/FSharp.Compiler.Service/)
15+
* [Developer notes explain the project structure](http://fsharp.github.io/FSharp.Compiler.Service/devnotes.html)
1516

17+
Build and Test
18+
-----
1619

1720
.NET Framework:
1821

19-
| | Ubuntu (Build) | Windows (Debug Build) | Windows (Release Tests 1) | Windows (Release Tests 2) | Windows (Release Tests 3) |
20-
|:----------:|:----------------:|:----------------:|:------------------:|:-----------------------:|:---------------------:|
21-
|**master** |[![Build Status](https://ci2.dot.net/buildStatus/icon?job=Microsoft_visualfsharp/master/release_ubuntu14.04)](https://ci2.dot.net/job/Microsoft_visualfsharp/job/master/job/release_ubuntu14.04/)|[![Build Status](https://ci2.dot.net/buildStatus/icon?job=Microsoft_visualfsharp/master/debug_windows_nt)](https://ci2.dot.net/job/Microsoft_visualfsharp/job/master/job/debug_windows_nt/)|[![Build Status](https://ci2.dot.net/buildStatus/icon?job=Microsoft_visualfsharp/master/release_ci_part1_windows_nt)](https://ci2.dot.net/job/Microsoft_visualfsharp/job/master/job/release_ci_part1_windows_nt/)|[![Build Status](https://ci2.dot.net/buildStatus/icon?job=Microsoft_visualfsharp/master/release_ci_part2_windows_nt)](https://ci2.dot.net/job/Microsoft_visualfsharp/job/master/job/release_ci_part2_windows_nt/)|[![Build Status](https://ci2.dot.net/buildStatus/icon?job=Microsoft_visualfsharp/master/release_ci_part3_windows_nt)](https://ci2.dot.net/job/Microsoft_visualfsharp/job/master/job/release_ci_part3_windows_nt/)|
22-
|**vs2017-rtm** |[![Build Status](https://ci2.dot.net/buildStatus/icon?job=Microsoft_visualfsharp/vs2017-rtm/release_ubuntu14.04)](https://ci2.dot.net/job/Microsoft_visualfsharp/job/vs2017-rtm/job/release_ubuntu14.04/)|[![Build Status](https://ci2.dot.net/buildStatus/icon?job=Microsoft_visualfsharp/vs2017-rtm/debug_windows_nt)](https://ci2.dot.net/job/Microsoft_visualfsharp/job/vs2017-rtm/job/debug_windows_nt/)|[![Build Status](https://ci2.dot.net/buildStatus/icon?job=Microsoft_visualfsharp/vs2017-rtm/release_ci_part1_windows_nt)](https://ci2.dot.net/job/Microsoft_visualfsharp/job/vs2017-rtm/job/release_ci_part1_windows_nt/)|[![Build Status](https://ci2.dot.net/buildStatus/icon?job=Microsoft_visualfsharp/vs2017-rtm/release_ci_part2_windows_nt)](https://ci2.dot.net/job/Microsoft_visualfsharp/job/vs2017-rtm/job/release_ci_part2_windows_nt/)|[![Build Status](https://ci2.dot.net/buildStatus/icon?job=Microsoft_visualfsharp/vs2017-rtm/release_ci_part3_windows_nt)](https://ci2.dot.net/job/Microsoft_visualfsharp/job/vs2017-rtm/job/release_ci_part3_windows_nt/)|
23-
22+
fcs\build.cmd Test.NetFx
2423

25-
## Help improve the Quality of the Tools by Using the Nightly Releases of Visual F# Tools
26-
To setup Visual Studio to use the latest nightly releases of the Visual F# Tools:
27-
https://blogs.msdn.microsoft.com/dotnet/2017/03/14/announcing-nightly-releases-for-the-visual-f-tools/
24+
fcs/build.sh Test.NetFx
2825

26+
.NET Core / .NET Standard
2927

30-
build.cmd All.NetFx
31-
(unix: ./build.sh All.NetFx)
28+
fcs\build.cmd Test.NetStd
3229

33-
.NET Core
30+
fcs/build.sh Test.NetStd
3431

35-
build All.NetCore
32+
Packages:
3633

37-
Both:
38-
39-
build All
34+
build NuGet
35+
build TestAndNuGet
4036

4137

4238
Build Status
@@ -53,36 +49,12 @@ Stable builds are available in the NuGet Gallery:
5349

5450
All AppVeyor builds are available using the NuGet feed: https://ci.appveyor.com/nuget/fsgit-fsharp-compiler-service
5551

56-
## Using
57-
58-
For typical installs of F#, see http://fsharp.org.
59-
60-
### Using Nightly Releases of Visual F# Tools
61-
62-
To setup Visual Studio to use the latest nightly releases of the Visual F# Tools:
63-
64-
https://blogs.msdn.microsoft.com/dotnet/2017/03/14/announcing-nightly-releases-for-the-visual-f-tools/
65-
66-
### Using CI Builds
67-
68-
To install F#, see http://fsharp.org.
69-
70-
To download the bits for the latest CI builds see [these instructions](https://github.com/Microsoft/visualfsharp/wiki/Using-CI-Builds). This includes and ZIPs containing the F# compiler and VSIX installers for the Visual F# IDE Tools.
71-
72-
### Using F# on a build server or computer without an F# installation
73-
74-
If you wish to use the latest F# compiler on a computer without Visual Studio 2017 installed, you can add the nuget package ``FSharp.Compiler.Tools`` to your projects. This will replace the in-box compiler with the version contained in the package.
75-
The actual package is built in https://github.com/fsharp/fsharp.
76-
77-
You will need to adjust the targets reference on your project file to use the targets file from the installed ``FSharp.Compiler.Tools`` package.
78-
See https://github.com/fsharp/fsharp/issues/676 for how to modify your project file.
79-
80-
## Code of Conduct
81-
82-
This project has adopted the code of conduct defined by the [Contributor Covenant](http://contributor-covenant.org/) to clarify expected behavior in our community. This code of conduct has been [adopted by many other projects](http://contributor-covenant.org/adopters/). For more information see the [Code of conduct](https://github.com/Microsoft/visualfsharp/wiki/Code-of-Conduct).
52+
If using Paket, add the source at the top of `paket.dependencies`.
8353

84-
## Get In Touch
54+
Maintainers
55+
-----------
8556

86-
Follow [@VisualFSharp](https://twitter.com/VisualFSharp) and [@fsharporg](https://twitter.com/fsharporg) on twitter and subscribe to the [.NET Blog](https://blogs.msdn.microsoft.com/dotnet/).
57+
The maintainers of this repository from the F# Core Engineering Group are:
8758

88-
Members of the F# Software Foundation can be invited to the "F# Software Foundation" discussion rooms on slack. More details at http://fsharp.org/guides/slack/.
59+
- [Don Syme](http://github.com/dsyme), [Dave Thomas](http://github.com/7sharp9), [Enrico Sada](http://github.com/enricosada)
60+
- with help and guidance from [Robin Neatherway](https://github.com/rneatherway), [Tomas Petricek](http://github.com/tpetricek), [Lincoln Atkinson](http://github.com/latkin), [Kevin Ransom](http://github.com/KevinRansom), [Vladimir Matveev](http://github.com/vladima) and others

0 commit comments

Comments
 (0)