Create README.md

README.md

@@ -0,0 +1,45 @@
+# Simple Music Notation Processor
+SMNP is a command line tool aimed on doing music stuff using custom domain-specific language.
+You are able to create music (both monophonic and polyphonic) using simple notation 
+and then synthesize it with custom settings, plot the signal, evaluate DFT on it and so on.
+Music tools can be used not only to create music but also to prepare kind of scenarios 
+of ear trainings like recognizing intervals etc.
+Apart of that developed domain-specific language offers you tools known from most popular 
+programming languages like conditional statements, loops, variable mechanism, 
+functions (including defining custom ones) etc.
+  
+It is based on my [previous project](https://github.com/bartlomiej-pluta/Simple-Music-Notation-Processor), however, it is
+totally rewritten in Kotlin with improved syntax, application architecture and some new features.
+Please don't be surprised if a great part of the _README_ or documentation is 1:1 copied from the older _SMNP_ project.
+The main purposes and general design are kept so there simply is no need to change these parts.
+
+## For what?
+You might ask whether such kind of tool including design of custom language isn't 
+over-engineering of ear-training problem. There are a lot of ear-training tools developed even
+on mobile platforms which can make them more convenient to use because of their portability feature.  
+
+The reasons for this tool are:
+* I'm Java developer and I just wanted to get know more ~~Python~~ Kotlin (...)
+Besides, I'm kind of interested in technical side of programming languages that I'm using at work, 
+so designing and implementing a custom language from scratch would be a nice experience. 
+* I'm musician also and no one of available tools is suitable for me. 
+I'm church organist and most of my work is based on dialogue between me and priest. He can
+sing melodies in different keys and it requires me to answer keeping the same key. 
+My tool allows me to create scenarios that can pick one key randomly and play melody 
+waiting for my answer (basing on input from microphone).
+* As a musician I'm also keen on physic nature of sounds and relations between them. 
+The tool allows me as a user to build (_synthesize_) my custom sound starting with pure sine waves.
+It is great to see how the nature of sound works.
+* The tool is lightweight - one of the core assumptions is to use as few 3rd party dependencies, frameworks and libraries
+as possible. Thanks to that, the base modules: `smnp.midi` and `smnp.synth` 
+which correspond to MIDI engine and synthesising engine respectively are implemented using plain old Java library, nothing else.
+
+## Documentation
+Documentation has been edited with _GitHub Wiki Pages_ and is available [here](https://github.com/bartlomiej-pluta/smnp/wiki).
+
+## Disclaimers
+1. Readability of the code and its structure is one of most important things
+related to educational aspect of the project. And in spite of having huge negative impact 
+on efficiency of the tool, according to one of the assumptions 
+it has much higher priority. So don't be surprised 
+if the tool turns out to be extremely slow or ineffective.