docs: Documentation and License.

Signed-off-by: Johannes Tegnér <johannes@jitesoft.com>

Author: Johannestegner

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Jitesoft AB
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,64 @@
+# CC-GEN
+
+A generator of changelog from conventional commits.
+
+## Work in progress
+
+This program is a work in progress, some features works basically as intended, 
+but more should be added and the code is quite messy.
+Use at your own risk!
+
+## Why?
+
+There are a lot of changelog generators out there, the reason for this one is 
+that the ones already existing either did not work with lightweight tags
+or required a lot of extra things installed to work.  
+The idea of cc-gen is to have a simple single binary which is easy to
+run and easy to modify both in form of code and the templates/configuration
+which is used to generate output.
+
+## How?
+
+There are currently two commands, `init` and `generate|gen`.  
+The former creates a configuration file locally or globally which allows
+you to change the templates used to generate the changelogs.  
+The later will generate a changelog.
+
+### Init
+
+The init command can be invoked with a --global flag, in which case it will
+create a .cc-gen file in your home directory with the default configuration.  
+
+Without the --global flag, the file will be created in the directory where
+the command was invoked.
+
+The following configuration values are available:
+
+`Header` - The header of the changelog, defaults to '# Change Log'  
+`GroupBreakingChanges` - If any breaking changes should have their own section
+in the changelog, defaults to true.  
+`GroupBreakingHeader` - Header for breaking changes, defautls to '## Breaking changes'  
+`Type` - Template for 'Types'  
+`DefaultType` - Type any non-matched commits will go under (commits following cc but not found in TypeMap)  
+`TypeMap` - A map of 'types' and their possible values in the commit messages  
+`BreakingCommit` - Template for breaking changes, only used if 'GroupBreakingChanges' is false  
+`Commit` - Template for commits  
+
+
+```text 
+Default for 'Commit':
+  * [ {{ commit.sha | string.slice1 0 6 }} ] {{ header }} ({{ commit.committer.name }}) {{ commit.committer.when }}  
+
+Default for 'BreakingCommit' 
+  * [ {{ commit.sha | string.slice1 0 6 }} ] **breaking** {{ header }} ({{ commit.committer.name }}) {{ commit.committer.when }}  
+```
+
+_Will later fill this part with a bit more information on what is passed to the template engine,
+for now, check the 'Conventional.cs' class_
+
+## With what?
+
+The application makes use of [LibGit2Sharp](https://github.com/libgit2/libgit2sharp/) to 
+work with the git log and [Scriban](https://github.com/scriban/scriban) to handle the templates.  
+The command line helper used is [System.CommandLine](https://github.com/dotnet/command-line-api) 
+and tests makes use of [XUnit](https://xunit.net/) and [Moq](https://github.com/moq/moq)

cc-gen.sln

@@ -4,6 +4,14 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "cc-gen", "cc-gen\cc-gen.csp
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "cc-gen.tests", "cc-gen.tests\cc-gen.tests.csproj", "{78E23272-05CB-4FCD-9AE8-CFD158FF73A5}"
 EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "misc", "misc", "{7E30A818-2618-4AB0-ABFB-C070E6138FDD}"
+	ProjectSection(SolutionItems) = preProject
+		.gitignore = .gitignore
+		cc-gen.sln = cc-gen.sln
+		README.md = README.md
+		LICENSE = LICENSE
+	EndProjectSection
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU