You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# The F# Language, Library, and Visual F# Tools Repository
1
+
# The F# compiler, F# core library, and F# editor tools
2
2
3
-
You are invited to help produce 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.
3
+
You're invited to contribute to future releases of the F# compiler, core library, and tools. Development of this repository can be done on any OS supported by [.NET Core](https://dotnet.microsoft.com/).
4
4
5
-
*[About F#](http://fsharp.org)
6
-
*[Testimonials](http://fsharp.org/testimonials)
7
-
*[Contributing](#contributing)
8
-
*[Using](#using)
5
+
## Contributing
6
+
7
+
### Quickstart on Windows
8
+
9
+
Build from the command line:
10
+
11
+
```bash
12
+
build.cmd
13
+
```
14
+
15
+
After it's finished, open either `FSharp.sln` or `VisualFSharp.sln` in your editor of choice. The latter solution is larger but includes the F# tools for Visual Studio and its associated infrastructure.
16
+
17
+
### Quickstart on Linux or macOS
18
+
19
+
Build from the command line:
9
20
10
-
The F# Compiler and Tools are also mirrored in [the corresponding repository](http://github.com/fsharp/fsharp) of the F# Software Foundation.
21
+
```bash
22
+
sh ./build.sh
23
+
```
11
24
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.
25
+
After it's finished, open `FSharp.sln`in your editor of choice.
13
26
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".
27
+
### More options and information
15
28
29
+
See [DEVGUIDE.md](DEVGUIDE.md) and [TESTGUIDE.md](TESTGUIDE.md) for more details on additional configurations for building and testing, how to update compiler error messages, and more.
16
30
17
31
## Build Status
18
32
@@ -22,24 +36,24 @@ For historical reasons this repository is called "visualfsharp" and currently al
You can use the latest `master` build of the F# compiler and tools for Visual Studio via our nightly releases if you are a Visual Studio user. See details on setup here:
See [DEVGUIDE.md](DEVGUIDE.md) and [TESTGUIDE.md](TESTGUIDE.md) for details on build, development, and testing.
45
+
### Even more nightly than the nightly
33
46
34
-
See [CONTRIBUTING.md](CONTRIBUTING.md) for general guidelines on the contribution process, also [how we label issues and PRs](https://github.com/dotnet/roslyn/wiki/Labels-used-for-issues)
47
+
Alternatively, if you _really_ want to live on the bleeding edge, you can set up a nightly feed for the Visual Studio preview releases, which use the latest commit in the preview branch. To do so, follow the same instructions as the above blog post, but instead with these links:
35
48
36
-
To contribute to the F# ecosystem more generally see the F# Software Foundation's [Community Projects](http://fsharp.org/community/projects/) pages.
49
+
* Set your feed to the preview feed: https://dotnet.myget.org/F/fsharp-preview/vsix
50
+
* Install a VSIX manually from the preview feed: https://dotnet.myget.org/feed/fsharp-preview/package/vsix/VisualFSharp
37
51
38
52
## Branches
39
53
40
54
These are the branches in use:
41
55
42
-
*`master` = Latest branch for OSS developers and nightly users.
56
+
*`master`
43
57
- Most contributions go here.
44
58
- Able to be built, installed and used in the latest public Visual Studio release.
45
59
- May contain updated F# features and logic.
@@ -48,61 +62,48 @@ These are the branches in use:
48
62
- Gets integrated into https://github.com/fsharp/FSharp.Compiler.Service to form the basis of FSharp.Compiler.Service releases
49
63
50
64
*`dev15.9`
51
-
-Servicing branch for VS 2017 update 15.9. We do not expect to service that release, but if we do, that's where the changes would go.
65
+
-Long-term servicing branch for VS 2017 update 15.9.x. We do not expect to service that release, but if we do, that's where the changes will go.
52
66
53
67
*`dev16.x`
54
68
- Latest release branch for the particular point release of Visual Studio.
55
69
- Incorporates features and fixes from master up to a particular branch point, then selective cherry-picks.
56
70
- May contain new features that depend on new things or fixes in the corresponding forthcoming Visual Studio release.
57
71
- Gets integrated back into master once the corresponding Visual Studio release is made.
58
72
59
-
### Technical Documentation
60
-
61
-
*[The F# Language and Core Library RFC Process](http://fsharp.github.io/2016/09/26/fsharp-rfc-process.html)
73
+
## F# language and core library evolution
62
74
63
-
*[The F# Language Specification](http://fsharp.org/specs/language-spec/)
maintained by contributors to this repository. Please read
67
-
and contribute to that guide.
75
+
Evolution of the F# language and core library follows a process spanning two additional repositories. The process is as follows:
68
76
69
-
### License
77
+
1. Use the [F# language suggestions repo](https://github.com/fsharp/fslang-suggestions/) to search for ideas, vote on ones you like, submit new ideas, and discuss details with the F# community.
78
+
2. Ideas that are "approved in principle" are eligible for a new RFC in the [F# language design repo](https://github.com/fsharp/fslang-design). This is where the technical specification and discussion of approved suggestions go.
79
+
3. Implementations and testing of an RFC are submitted to this repository.
70
80
71
-
This project is subject to the MIT License. A copy of this license can be found in [License.txt](License.txt) at the root of this repo.
81
+
## Additional project documentation
72
82
83
+
The following links can help you get an overview of some technical aspects of the F# language and compiler:
73
84
74
-
## Using
75
-
76
-
For typical installs of F#, see http://fsharp.org.
77
-
78
-
### Using Nightly Releases of Visual F# Tools
79
-
80
-
To setup Visual Studio to use the latest nightly releases of the Visual F# Tools:
If you wish to set up a *Preview* nightly atop Visual Studio preview builds, you can either [download a VSIX Manually from here](https://dotnet.myget.org/feed/fsharp-preview/package/vsix/VisualFSharp) or set up a VSIX feed in visual studio from [here](https://dotnet.myget.org/F/fsharp-preview/vsix).
*[The F# Language Specification](http://fsharp.org/specs/language-spec/)
87
87
88
-
To install F#, see http://fsharp.org.
88
+
## License
89
89
90
-
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.
90
+
This project is subject to the MIT License. A copy of this license is in [License.txt](License.txt).
91
91
92
-
### Using F# on a build server or computer without an F# installation
92
+
##Code of Conduct
93
93
94
-
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.
95
-
The actual package is built in https://github.com/fsharp/fsharp.
94
+
This project has adopted the [Contributor Covenant](http://contributor-covenant.org/) code of conduct to clarify expected behavior in our community. You can read it at [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md).
96
95
97
-
You will need to adjust the targets reference on your project file to use the targets file from the installed ``FSharp.Compiler.Tools`` package.
98
-
See https://github.com/fsharp/fsharp/issues/676 for how to modify your project file.
96
+
## Get In Touch
99
97
100
-
## Code of Conduct
98
+
Members of the [F# Software Foundation](http://fsharp.org) are invited to the [FSSF Slack](http://fsharp.org/guides/slack/). You can find support from other contributors in the `#compiler` and `#editor-support` channels.
101
99
102
-
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).
100
+
Additionally, you can use the `#fsharp` tag on Twitter if you have general F# questions, including about this repository. Chances are you'll get multiple responses.
103
101
104
-
## Get In Touch
102
+
## About F#
105
103
106
-
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/).
104
+
If you're curious about F# itself, check out these links:
107
105
108
-
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/.
106
+
*[What is F#](https://docs.microsoft.com/dotnet/fsharp/what-is-fsharp)
107
+
*[Get started with F#](https://docs.microsoft.com/dotnet/fsharp/get-started/)
0 commit comments