Skip to content

Commit 62be16f

Browse files
committed
Added readme.nd to clarify purpose of this repo
1 parent c31f500 commit 62be16f

2 files changed

Lines changed: 28 additions & 0 deletions

File tree

CommandlineParsing.sln

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,11 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Samples", "Samples", "{D50F
3030
EndProject
3131
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "SampleArgs", "SampleArgs\SampleArgs.csproj", "{694CC71C-BD60-4B94-BC64-391949BA269E}"
3232
EndProject
33+
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{83C217F8-0B68-4729-A201-F3D3B9CA784E}"
34+
ProjectSection(SolutionItems) = preProject
35+
readme.md = readme.md
36+
EndProjectSection
37+
EndProject
3338
Global
3439
GlobalSection(SolutionConfigurationPlatforms) = preSolution
3540
Debug|Any CPU = Debug|Any CPU

readme.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Purpose of this project
2+
To be clear up front, this is **NOT** a production ready general purpose command line parsing library,
3+
__nor is it intended to be one__.
4+
5+
This repository is intended to serve a few roles for the Ubiquity.NET set of projects:
6+
7+
1. Acts as a template for new projects
8+
2. Provides and experimental playground for the Ubiquity DocFX template and general docs build infrastructure.
9+
3. Test project for various aspects of cross targeting .NET run-times (.NET Core or desktop) including non-Windows
10+
target run-times
11+
12+
While the code is functional and even has some tests it isn't maintained or released as
13+
an actual supported project. New ideas in the way things are built including docs and versioning etc... will
14+
appear here first before actual projects. To accomplish the goals some reasonable real code was needed so this
15+
old library originally written to explore the Sprache parse was given a new lease on life as a "test dummy" of sorts.
16+
17+
# OK, But I'm looking for a commandline parser...
18+
May we suggest [this one]( https://github.com/commandlineparser/commandline ) - it's on GitHub and MUCH more full
19+
featured, in fact command line apps for Ubiquity.NET will use that one instead of this one, so that should tell
20+
you something if you are considering using this.
21+
22+
# But I really like this library because...
23+
OK, what the heck, it's OSS on GitHub, fork it and party on! Just be aware you are on your own for maintaining it.

0 commit comments

Comments
 (0)