RecRoom
How to get started
- Add links to GH project in all places marked
TODO: ADD_LINK
- Add name of the author in all places marked
TODO: ADD_AUTHOR
- Search for any other places makred with
TODO:
- Fill content of
src/Directory.Build.props
What's included
- Paket, FAKE, and Fornax added as
dotnet
local tools (.config/dotnet-tools.json
) build.fsx
file, containing default FAKE script with targets for building, testing, documentation generation, publishing to GitHub, and publishing to NuGetpaket.dependencies
with basic set of dependenciessrc
folder containing 2 projects - one class library (netstandard2.0
), and CLI tool (netcoreapp3.1
)test
folder containing UnitTest project using Expecto and FsCheckdocs
folder with Fornax documentation template that will generate nice documentation for your project..devcontainer
folder with definition of Development Container.github/workflows
folder with definition for 2 GitHub actions - one for building and testing code as CI, one for deploying documentation when new tag is pushed. To use latter, you need to definePERSONAL_TOKEN
secret in GitHub repo settings with Personal Access Token..github/ISSUE_TEMPLATE
folder with 2 different issue templates - one for bug report, other one for feature request
How to build application
- Make sure you've installed .Net Core version defined in global.json
- Run
dotnet tool install
to install all developer tools required to build the project - Run
dotnet fake build
to build default target of build script - To run tests use
dotnet fake build -t Test
- To build documentation use
dotnet fake build -t Docs
Documentation Theme
Template includes, out-of-the-box, nice theme for your project documentation, which integrates with FSharp.Formatting to create also API reference
- Sample documentation produced by the template can be found on http://kcieslak.io/SampleRecRoom.
- Created theme is partial port to Fornax of Hugo Learn theme.
- You define content as markdown files
- Support for unlimited multi-level navigation
- Use FSharp.Formatting to create API reference for the project - sample: http://kcieslak.io/SampleRecRoom/Reference/ApiRef.html
- Use Lunr.js to provide client side search based on generated by Fornax search index - sample: try searching for
Lorem
orSample
in search available on http://kcieslak.io/SampleRecRoom - Use Mermaid.js to provide client side render diagrams and graphs - sample: http://kcieslak.io/SampleRecRoom/diagrams.html
How to release.
Create release.cmd or release.sh file (already git-ignored) with following content (sample from cmd
, but sh
file should be similar):
@echo off
cls
SET nuget-key=YOUR_NUGET_KEY
SET github-user=YOUR_GH_USERNAME
SET github-pw=YOUR_GH_PASSWORD_OR_ACCESS_TOKEN
dotnet fake build --target Release
How to contribute
Imposter syndrome disclaimer: I want your help. No really, I do.
There might be a little voice inside that tells you you're not ready; that you need to do one more tutorial, or learn another framework, or write a few more blog posts before you can help me with this project.
I assure you, that's not the case.
This project has some clear Contribution Guidelines and expectations that you can read here.
The contribution guidelines outline the process that you'll need to follow to get a patch merged. By making expectations and process explicit, I hope it will make it easier for you to contribute.
And you don't just have to write code. You can help out by writing documentation, tests, or even by giving feedback about this work. (And yes, that includes giving feedback about the contribution guidelines.)
Thank you for contributing!
Contributing and copyright
The project is hosted on [GitHub](TODO: ADD_LINK) where you can report issues, fork the project and submit pull requests.
The library is available under MIT license, which allows modification and redistribution for both commercial and non-commercial purposes.
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.