@ -10,8 +10,8 @@ If you write a command-method which takes no arguments, you must make sure you s
For further information, please refer to the `ConsoleCommands` module in either the ".Net" or ."Net Core" console projects. You might need them to help explain this next point. The links for these modules are as follows:
Welcome to the wiki of Brittle-Fish. If you are looking to learn about **using** Console.Waterworks in a F#-only environment, you have come to the right place. The aim of this wiki is to teach you about using Console.Waterworks in an F# context. I recommend you read the actual Console.Waterworks wiki if you want to know how it works. You can head over to the wiki by clicking the following link,
@ -55,7 +55,7 @@ One way to change the assembly information in your .Net program is to alter it v
- [Setting Assembly Attributes](https://docs.microsoft.com/en-us/dotnet/framework/app-domains/set-assembly-attributes): This applies to the traditional and Core versions of .Net. It provides information on what resides in Assembly Information manifests and files.
- [How to Target a version of .Net](https://docs.microsoft.com/en-us/visualstudio/ide/how-to-target-a-version-of-the-dotnet-framework?view=vs-2019): This provides extra context on the Properties page in Visual Studio and how it fits the Assembly Information dialog box into it -- from a traditional .Net angle.
- [The AssemblyInfo.fs file for BrittleFish](https://gitlab.com/craig.oates/Brittle-Fish/blob/master/BrittleFish/AssemblyInfo.fs): The actual Assembly Information file for the BrittleFish console program. Use this as a reference for your own projects.
- [The AssemblyInfo.fs file for BrittleFish](https://git.abbether.net/craig.oates/Brittle-Fish/blob/master/BrittleFish/AssemblyInfo.fs): The actual Assembly Information file for the BrittleFish console program. Use this as a reference for your own projects.
You might find you do not have a file called "AssemblyInfo.fs" within your project. If you are unfamiliar with these types of files, feel free to peruse the links above for help on learning how to add it. As an alternative, you can create a file in your project (in Visual Studio) and call it "AssemblyInfo.fs" -- make sure it is at the **root** level. From there, you can copy and paste the following code block into it (making sure you replace the code wrapped in `{delete the braces when you add your own info.}`):
@ -106,19 +106,19 @@ do
To help you get a sense of where this file should live, please review the file structure for BrittleFish. You can do that by using the following link:
Like the traditional .Net version, you can use the Properties dialog box in Visual Studio. Use the links below for extra information, which are:
- [Application Page, Project Designer (C#)](https://docs.microsoft.com/en-us/visualstudio/ide/reference/application-page-project-designer-csharp?view=vs-2019): This show you how to access the Properties page box and provides more information on how the Assembly Information dialog box fits into it -- from a .Net Core perspective.
- [The AssemblyInfo.fs file for BrittleFishCore](https://gitlab.com/craig.oates/Brittle-Fish/blob/master/BrittleFishCore/AssemblyInfo.fs): The actual Assembly Information file for the BrittleFishCore console program. Use this as a reference for your own projects.
- [The AssemblyInfo.fs file for BrittleFishCore](https://git.abbether.net/craig.oates/Brittle-Fish/blob/master/BrittleFishCore/AssemblyInfo.fs): The actual Assembly Information file for the BrittleFishCore console program. Use this as a reference for your own projects.
I tend to find, Visual Studio automatically makes a "AssemblyInfo.fs" file when I create a .Net Core project. So, I do not need to go out of my way to make one. If, for some reason, you find yourself without one, you can use the same technique in the ".Net" section above. The same applies to the code block within it.
Like the section above, you can get a sense of where "AssemblyInfo.fs" should live (in a .Net Core project) by reviewing the file structure for BrittleFishCore. You can do that by using the following link:
What is important to note here is the command-methods name. This is what the end-user must enter at run-time to execute said command-method. The input is, also, case-sensitive. So, if you wanted to, you could use `test` and `Test` as seperate command-methods.
@ -32,6 +32,6 @@ Another feature of C.W. is it parses and coerces input arguments. This means you
To be clear, there are limits to the amount of types you can use with you command-methods. For a full list of all the coercion types, please refer to the [**Coercion Types List**](https://gitlab.com/craig.oates/Console.Waterworks/wikis/Coercion-Types-List) in the main C.W. wiki.
To be clear, there are limits to the amount of types you can use with you command-methods. For a full list of all the coercion types, please refer to the [**Coercion Types List**](https://git.abbether.net/craig.oates/Console.Waterworks/wikis/Coercion-Types-List) in the main C.W. wiki.
If you write a command-method with arguments not on the coercion list, you will get a **run-time** error. With that said, you are free to use whatever types you want **inside** the command-method.
