Skip to content

Commit 5b6f1d1

Browse files
authored
Doc updates to address #898 (#899)
* bump version * add explicit docs about the read-only nature of the repo also add contributing, issue template, and pr template to drive that point home * rever weird version changes
1 parent 462bcb9 commit 5b6f1d1

File tree

4 files changed

+49
-22
lines changed

4 files changed

+49
-22
lines changed

.github/issue_template.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# FSharp.Compiler.Service Issue Template
2+
3+
> Thanks for your intention to help out!
4+
5+
We appreciate your enthusiasm, but this repository is a *read-only* fork of the official F# compiler. Please raise your issue at the [upstream repo](https://github.com/microsoft/visualfsharp/issues/new).

.github/pull_request_template.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# FSharp.Compiler.Service PR Template
2+
3+
> Thanks for your intention to help out!
4+
5+
We appreciate your enthusiasm, but this repository is a *read-only* fork of the official F# compiler. Please raise your Pull Request at the [upstream repo](https://github.com/microsoft/visualfsharp/compare).

CONTRIBUTING.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Contributing to FSharp.Compiler.Service
2+
3+
> Thanks for your intention to help out!
4+
5+
We appreciate your enthusiasm, but this repository is a *read-only* fork of the official F# compiler. If you have issues, contributions, or questions, please raise them at the [upstream repo](https://github.com/microsoft/visualfsharp).

README.md

Lines changed: 34 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,34 @@
1-
F# Compiler Service
2-
===================
1+
# F# Compiler Service
32

4-
The F# compiler services package contains a custom build of the F# compiler that
3+
The FSharp.Compiler.Service package contains a custom build of the F# compiler that
54
exposes additional functionality for implementing F# language bindings, additional
65
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.
6+
interactive service that can be used for embedding F# scripting into your applications. This repository exists entirely to create and publish that package.
87

9-
Documentation
10-
-------------
8+
## Purpose
9+
10+
> This repo is (mostly) **read only**
11+
12+
This repo exists as a downstream packaging repository for the [FSharp.Compiler.Service](https://www.nuget.org/packages/FSharp.Compiler.Service) NuGet Package. It serves the following purposes _only_:
13+
14+
* Release packaging
15+
* Hosting [public documentation](http://fsharp.github.io/FSharp.Compiler.Service/)
16+
* Serving as a stable base for Fable
17+
18+
19+
It is a fork of the official F# source repository, which is located at [microsoft/visualfsharp](https://github.com/microsoft/visualfsharp). **All** issues and contributions should be raised there. All feature development should be targeted there. Once contributions are accepted into [microsoft/visualfsharp](https://github.com/microsoft/visualfsharp), they will be integrated into this repository for packaging and release.
20+
21+
If you need to add customizations to FSharp.Compiler.Service for your own uses, you should clone [microsoft/visualfsharp](https://github.com/microsoft/visualfsharp) and build the FSharp.Compiler.Service binaries from there. The process is exactly the same as it is described below.
22+
23+
24+
## Documentation
1125

1226
For more information about the project, see:
1327

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)
28+
* [F# Compiler Service API and usage documentation](http://fsharp.github.io/FSharp.Compiler.Service/)
29+
* [Description of the project structure](http://fsharp.github.io/FSharp.Compiler.Service/devnotes.html)
1630

17-
Build and Test
18-
-----
31+
## Build and Test
1932

2033
On Windows:
2134

@@ -25,21 +38,21 @@ On Linux:
2538

2639
./fcs/build.sh Test
2740

28-
Packages:
41+
To build NuGet packages:
2942

3043
build NuGet
3144
build TestAndNuGet
3245

46+
## Build Status
3347

34-
Build Status
35-
------------
36-
37-
Head (branch ``master``):
48+
Branch | OS | Badge |
49+
------ | ------ | - |
50+
master | Linux/OSX | [![Build Status](https://travis-ci.org/fsharp/FSharp.Compiler.Service.svg?branch=master)](https://travis-ci.org/fsharp/FSharp.Compiler.Service) |
51+
master | Windows | [![Build status](https://ci.appveyor.com/api/projects/status/3yllu2qh19brk61d?svg=true)](https://ci.appveyor.com/project/fsgit/fsharp-compiler-service) |
3852

39-
* Linux/OSX: [![Build Status](https://travis-ci.org/fsharp/FSharp.Compiler.Service.svg?branch=master)](https://travis-ci.org/fsharp/FSharp.Compiler.Service)
40-
* Windows: [![Build status](https://ci.appveyor.com/api/projects/status/3yllu2qh19brk61d?svg=true)](https://ci.appveyor.com/project/fsgit/fsharp-compiler-service)
53+
## NuGet package
4154

42-
NuGet [![NuGet Badge](https://buildstats.info/nuget/FSharp.Compiler.Service)](https://www.nuget.org/packages/FSharp.Compiler.Service)
55+
[![NuGet Badge](https://buildstats.info/nuget/FSharp.Compiler.Service)](https://www.nuget.org/packages/FSharp.Compiler.Service)
4356

4457
Stable builds are available in the NuGet Gallery:
4558
[https://www.nuget.org/packages/FSharp.Compiler.Service](https://www.nuget.org/packages/FSharp.Compiler.Service)
@@ -48,17 +61,16 @@ All AppVeyor builds are available using the NuGet feed: https://ci.appveyor.com/
4861

4962
If using Paket, add the source at the top of `paket.dependencies`.
5063

51-
License
52-
-----------
64+
## License
5365

5466
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.
5567

56-
Maintainers
57-
-----------
68+
## Maintainers
5869

5970
The maintainers of this repository are:
6071

6172
- [Don Syme](http://github.com/dsyme)
6273
- [Tomas Petricek](http://github.com/tpetricek)
6374
- [Enrico Sada](http://github.com/enricosada)
75+
- [Chet Husk](http://github.com/baronfel)
6476
- Many people have helped including [Robin Neatherway](https://github.com/rneatherway), [Dave Thomas](http://github.com/7sharp9), [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)