Browse Source

Added links to README.

master
Craig Oates 6 years ago
parent
commit
2665ce343e
  1. 12
      README.md

12
README.md

@ -5,10 +5,10 @@ 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. 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: For more information about the Console.Waterworks projects, use the following links:
- Console.Waterworks Link - [Console.Waterworks](https://github.com/CraigOates/Console.Waterworks)
- Console.Waterworks.Core Link - [Console.Waterworks.Core](https://github.com/CraigOates/Console.Waterworks.Core)
**Tip**: The main wiki is in the Console.Waterworks repository and I suggest you start there. **Tip**: The main wiki is in the Console.Waterworks repository and I suggest you start [there](https://github.com/CraigOates/Console.Waterworks/wiki).
## Pre-Requisites ## Pre-Requisites
@ -31,13 +31,13 @@ IMAGE OF THE SOLUTION STRUCTURE TO GO HERE.
If you are more of a *"where's the manual?"* type of person, I recommend you head over to the wiki. If you are more of a *"where's the manual?"* type of person, I recommend you head over to the wiki.
- Brittle Fish Wiki - [Brittle Fish Wiki](https://github.com/CraigOates/Brittle-Fish/wiki)
## Contributing to the Repository ## 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 out file an issue but you can email if you prefer. 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 out file an issue but you can email if you prefer.
- Issue - [Create a new issue](https://github.com/CraigOates/Brittle-Fish/issues)
- Email - 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. 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