Skip to content

Commit 5db4b86

Browse files
authored
Update README.md
1 parent e3f18c5 commit 5db4b86

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,14 +36,13 @@ with its small amount of corresponding [CSS and JavaScript](https://github.com/f
3636

3737
See [FSharp.Formatting styling](https://fsprojects.github.io/FSharp.Formatting/styling.html) for information on styling for output generated by `fsdocs`.
3838

39-
This template is *not* the long term plan (unless it is improved enough). We can and must improve the design. Please help with this, and please be bold.
39+
This template is *not* the long term plan (unless it is improved enough). We can improve the design - please help with this.
4040

41-
1. Adjust the template and CSS in `docs`. Rebuild as before. Your template will be used instead of the default template.
41+
1. Copy the default template and CSS to `docs`. Rebuild as before. This template will be used instead of the default template.
4242

43-
2. After you have identified fixes and improvements, contribute back to the default template of FSharp.Formatting, or submit your work here and we can assess that for you. If your design is good enough it might become a default design choice for all F# libraries.
44-
45-
It's a secondary goal of this repo to have the default template(s) of FSharp.Formatting to be good enough for this site. This means whatever improvements you make should eventually get copied across back into FSharp.Formatting (and the duplicated template and styling will then likely be removed from this repo once it's no longer needed). If the design diverges to be a completely different look and feel then we can make several templates available in FSharp.Formatting with this as one of them.
43+
2. After you have identified fixes and improvements, contribute back to the default template of FSharp.Formatting, or submit your work here and we can assess that. This will help improve many F# libraries.
4644

45+
Whatever improvements you make should eventually get copied across back into FSharp.Formatting (and the duplicated template and styling will then likely be removed from this repo once it's no longer needed). If the design diverges to be a completely different look and feel then we can make several templates available in FSharp.Formatting with this as one of them.
4746

4847

4948
## Build steps

0 commit comments

Comments
 (0)