Browse Source

Update README.md

master
Craig Oates 5 years ago
parent
commit
1ed573e2bf
  1. 14
      README.md

14
README.md

@ -5,17 +5,17 @@ Brittle Fish is a repository for testing and demonstrating the Console.Waterwork
Console.Waterworks is a NuGet package for creating MVC-like console programs. It allows you to define methods with parameters which the user can execute at runtime.
For more information about the Console.Waterworks projects, use the following links:
- [Console.Waterworks](https://github.com/CraigOates/Console.Waterworks)
- [Console.Waterworks.Core](https://github.com/CraigOates/Console.Waterworks.Core)
- [Console.Waterworks](https://gitlab.com/craig.oates/Console.Waterworks)
- [Console.Waterworks.Core](https://gitlab.com/craig.oates/Console.Waterworks.Core)
**Tip**: The main wiki is in the Console.Waterworks repository and I suggest you start [there](https://github.com/CraigOates/Console.Waterworks/wiki).
**Tip**: The main wiki is in the Console.Waterworks repository and I suggest you start [there](https://gitlab.com/craig.oates/Console.Waterworks/wikis/home).
## Pre-Requisites
The repository was created using the following,
- Dot Net 4.7+
- Dot Net Core 2+
- .Net 4.7+
- .Net Core 2+
- Visual Studio 2017 (15.7.3)
- F# 4.1
@ -31,13 +31,13 @@ If you are more of a *"show me the code"* type of person, clone the repository a
If you are more of a *"where's the manual?"* type of person, I recommend you head over to the wiki.
- [Brittle Fish Wiki](https://github.com/CraigOates/Brittle-Fish/wiki)
- [Brittle Fish Wiki](https://gitlab.com/craig.oates/Brittle-Fish/wikis/home)
## Contributing to the Repository
I do not intend for this to become an active repository. My main aim is for it to act as reference material for using Console.Waterworks in an F#-only environment. That being said, I am not against the odd crazy idea or two. If you manage to use Console.Waterworks in a useful and interesting way, let me know. I recommend filing an issue but you can email if you prefer.
- [Create a new issue](https://github.com/CraigOates/Brittle-Fish/issues)
- [Create a new issue](https://gitlab.com/craig.oates/Brittle-Fish/issues)
- Email: [craig@craigoates.net](mailto:craig@craigoates.net)
I do not anticipate a lot of feedback so I have not made an issues template. I have, also, not made a coding standard either. So, please be kind when posting an issue or pull request.
Loading…
Cancel
Save