The main purpose of this repository is to package the open editions of the F# compiler, core library and core tools for use across multiple platforms.
Most contributions to the F# compiler/library/tools go first via the
repository at https://github.com/Microsoft/visualfsharp. This ensures that the main
packaging of F# on Windows (the Visual F# Tools) also includes any contributions that are made, and
ensures that the versions do not diverge.
If you are using Windows, you should fork the https://github.com/Microsoft/visualfsharp repo and contribute directly there. Your contributions will then be merged into this repo.
If you are using Linux or OSX, you can prepare your contributions by forking this repository (the code is essentially the same). This will give you access to the cross-platform testing available from this repo. At the moment the process is:
- Fork this repo.
- Build and test using the subset of tests available in this repo. If you like, submit a PR to this repo in order to trigger an automatic Travis run, or set up a Travis hook in your fork.
- Seek initial review by posting an issue in this repository or https://github.com/Microsoft/visualfsharp. Make it clear you are working on Linux or OSX.
- Cherry-pick your changes into a pull request for https://github.com/Microsoft/visualfsharp and submit for final testing and clearance.
- The change will then be merged into this repo at a later point.
Contributions specifically related to cross-platform packaging should be made here.
The master branch is for F# 4.x. The fsharp4 branch archives F# 4.0, the fsharp31 branch archives F# 3.1.
To bootstrap the compiler, binaries built from an earlier version of this project are used.
This codebase uses the Apache 2.0 license.
| F# | Branch | OSX/Linux | Windows |
|---|---|---|---|
| 4.0+ | master |
 |
|
| 4.0 | fsharp4 |
 |
|
| 3.1 | fsharp31 |
 |
|
| 3.0 | fsharp_30 |
 |
This repo is currently used to make two NuGet packages - FSharp.Core and FSharp.Compiler.Tools.
Stable builds are available in the NuGet Gallery: http://www.nuget.org/packages/FSharp.Core and http://www.nuget.org/packages/FSharp.Compiler.Tools.
The FSharp.Core NuGet package includes all of the FSharp.Core redistributables from Visual F#. In addition, they include assemblies for MonoAndroid and MonoTouch built from this repository.
The FSharp.Compiler.Tools package includes the F# compiler fsc.exe, F# Interactive fsi.exe, build support,
a copy of FSharp.Core used to run the tools, and related DLLs.
It can be used if you wish to use the latest F# compiler on a computer without relying on the installed version of Visual Studio.
Adding it via nuget to a project will override the in-box compiler with the compiler from the nuget package.
Note: due to how previous versions of the default project templates referenced Microsoft.FSharp.Targets, you may need to manually modify your project file once (see fsharp#676).
A feed of nuget packages from builds is available from AppVeyor using the NuGet feed: https://ci.appveyor.com/nuget/fsgit-fsharp
If using Paket, add the source at the top of paket.dependencies.
source https://www.nuget.org/api/v2
source https://ci.appveyor.com/nuget/fsgit-fsharp
Add the dependency on FSharp.Core and run paket update. See the AppVeyor build history for a list of available versions. Here are some options for specifying the dependency:
nuget FSharp.Core
nuget FSharp.Core prerelease
nuget FSharp.Core 3.1.2.3
nuget FSharp.Core 3.1.2.3-b208
If using NuGet Package Manager, add the source to the list of available package sources.
Building F# on Unix-type platforms requires
Mono 4.4 or higher. If you
get a complaint in subsequent steps about xbuild being missing, it means
you don't have Mono installed.
Building on OS X requires several development tools that are not installed by default. Most can be installed via Homebrew:
brew install autoconf automake pkg-config
Building on OS X also requires Xcode. If you don't want to install the full GUI development environment, the command line tools are sufficient. At a shell prompt, say:
xcode-select --install
The usual:
./autogen.sh --prefix=/usr
make
sudo make install
By default that makes optimized binaries. To make debug, use make CONFIG=debug
Use a prefix to your version of Mono:
./autogen.sh --prefix=/Library/Frameworks/Mono.framework/Versions/Current/
make
sudo make install
By default that makes optimized binaries. To make debug, use make CONFIG=debug
Build using:
build.bat
This build the proto compiler, then the library, then the final compiler.
You can also build these independently using:
msbuild src\fsharp-proto-build.proj
ngen install lib\proto\fsc-proto.exe
msbuild src\fsharp-library-build.proj /p:Configuration=Release
msbuild src\fsharp-compiler-build.proj /p:Configuration=Release
You can also build FSharp.Core.dll for other profiles:
msbuild src\fsharp-library-build.proj /p:TargetFramework=net20 /p:Configuration=Release
msbuild src\fsharp-library-build.proj /p:TargetFramework=portable47 /p:Configuration=Release
msbuild src\fsharp-library-build.proj /p:TargetFramework=portable7 /p:Configuration=Release
msbuild src\fsharp-library-build.proj /p:TargetFramework=portable78 /p:Configuration=Release
msbuild src\fsharp-library-build.proj /p:TargetFramework=portable259 /p:Configuration=Release
msbuild src\fsharp-library-build.proj /p:TargetFramework=monodroid /p:Configuration=Release
msbuild src\fsharp-library-build.proj /p:TargetFramework=monotouch /p:Configuration=Release
Change to /p:Configuration=Debug for debug binaries.
xbuild src\fsharp-proto-build.proj
xbuild src\fsharp-library-build.proj
xbuild src\fsharp-compiler-build.proj
Building using xbuild does not yet lay down a Mono-ready distribution (see src/fsharp/targets.make), so should only be used for private development rather than preparing distributions.
The FSharp.Core.dll produced is only delay-signed (Mono does not require strong names). If a strong-name signed FSharp.Core.dll is needed then use the one in
lib\bootstrap\signed\.NETFramework\v4.0\4.3.0.0\FSharp.Core.dll
lib\bootstrap\signed\.NETFramework\v4.0\4.3.1.0\FSharp.Core.dll
Built main compiler binaries go to Release/net40/bin
make install sends the binaries to the prefix location, e.g.
/Library/Frameworks/Mono.framework/Versions/Current/lib/mono/2.0/FSharp.Core.dll
/Library/Frameworks/Mono.framework/Versions/Current/lib/mono/2.1/FSharp.Core.dll
/Library/Frameworks/Mono.framework/Versions/Current/lib/mono/4.0/fsc.exe
/Library/Frameworks/Mono.framework/Versions/Current/lib/mono/4.0/FSharp.Compiler.dll
...
/Library/Frameworks/Mono.framework/Versions/Current/lib/mono/4.5/fsc.exe
/Library/Frameworks/Mono.framework/Versions/Current/lib/mono/4.5/FSharp.Compiler.dll
...
/Library/Frameworks/Mono.framework/Versions/Current/lib/mono/gac/.../FSharp.Compiler.dll
/Library/Frameworks/Mono.framework/Versions/Current/lib/mono/gac/.../FSharp.Compiler.dll
...
plus some files for xbuild support
/Library/Frameworks/Mono.framework/Versions/Current/lib/mono/Microsoft\ F#/v4.0/*
/Library/Frameworks/Mono.framework/Versions/Current/lib/mono/Microsoft\ SDKs/F#/3.0/Framework/*
(these names are the canonical names for Microsoft.FSharp.Targets used by project files coming from Visual Studio)
plus scripts
/usr/bin/fsharpc (F# compiler)
/usr/bin/fsharpi (F# Interactive)
Feel free to send in-progress Pull Requests to ask for clarification or direction for a feature or task.
To integrate latest changes from https://github.com/Microsoft/visualfsharp, use
git remote add visualfsharp https://github.com/Microsoft/visualfsharp
git pull visualfsharp master
There are certain guidelines that need to be followed when integrating changes from upstream:
- this repository does not undergo the QA test process that upstream does, so the
tests/fsharpqafolder and all files within should be removed when merging - this repository does not contain any of the Visual Studio tooling or integrations, so the
vsintegrationdirectory and all files within should be removed when merging - anything referencing
FSharp.LaunguageService.Compileris a Microsoft-internal version of the open FSharp.Compiler.Service repository, and as such should be removed when merging - Windows-specific
update.cmdandruntests.cmdaren't used in this repository, and so should be removed when merging - anything that references the
Salsatesting library is used by Microsoft to test the Visual Studio integrations, and as such should be removed when merging - the foremost example of the above is the
root/unittestsfolder, which contains tests for the Visual Studio integration using Salsa, and as such should be removed when merging
A continuous integration build is set up with Travis. See above.
Historically it is difficult to edit the compiler with Xamarin Studio or MonoDevelop because of bugs in loading the hand-edited project files and targets used in the F# compiler build. These are generally in the process of being fixed, your mileage will vary.
Only a subset of the tests are currently enabled.
After building and installing, run
cd tests/fsharp/core
./run-all.sh
See the TESTGUIDE.md for instructions for how to test on Windows. Use that repository to develop and test on Windows.
F# compiler sources as initially dropped are available from fsharppowerpack.codeplex.com.
On 4 April 2014, Microsoft Open Tech published the F# compiler sources at http://visualfsharp.codeplex.com and began accepting contributions to the F# compiler/library and tools.
In 2016 the Microsoft http://visualfsharp.codeplex.com repo moved to GitHub at http://github.com/Microsoft/visualfsharp.
This repository uses bootstrapping libraries, tools and F# compiler. The lib/bootstrap/X.0 directories contain mono-built libraries, compiler and tools that can be used to bootstrap a build. You can also supply your own via the --with-bootstrap option.
vagrant up
vagrant ssh
cd /vagrant
sudo apt-get install dos2unix autoconf
./autogen.sh --prefix=/usr
make
sudo make install
The maintainers of this repository appointed by the F# Core Engineering Group are:
- Tomas Petricek, Robin Neatherway
- with help and guidance from Don Syme, Cameron Taggart, Dave Thomas, Jo Shields, Lincoln Atkinson, Kevin Ransom and Henrik Feldt