doc: Add CHANGELOG and README

zarubaf · zarubaf · commit 58394a5846eb · 2020-03-12T09:54:11.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,16 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## 0.1.0 - 2019-09-26
+## Added
+- First version able to re-name modules and instantiations (pre- and suffix).
+- Minimization and comment stripping.
+- Based on [Moore](https://github.com/fabianschuiki/moore) parser.
+
+## Unreleased
+
+
+
diff --git a/README.md b/README.md
@@ -0,0 +1,3 @@
+# Morty
+
+Morty reads SystemVerilog files and pickles them into a single file for easier handling. Optionally it allows to re-name modules with a common prefix or suffix. This allows for easier management of larger projects (they just become a single file). By making them unique they can also depend on different versions of the same dependency without namespace clashes.

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# Morty`
	`2`	`+`
	`3`	`+Morty reads SystemVerilog files and pickles them into a single file for easier handling. Optionally it allows to re-name modules with a common prefix or suffix. This allows for easier management of larger projects (they just become a single file). By making them unique they can also depend on different versions of the same dependency without namespace clashes.`