Merge branch 'master' of https://github.com/DiscoveryGroup/syntaxmaker

Author: Hämäläinen, Mika K

.gitignore

@@ -1,2 +1,3 @@
 *.*~
 *.pyc
+.idea/*

.idea/.name

@@ -1,4 +1,4 @@
-   Copyright 2015 Mika Hämäläinen, University of Helsinki
+   Copyright 2015-2017 Mika Hämäläinen
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

.idea/misc.xml

@@ -1,4 +1,20 @@
-# Syntaxmaker
-A python NLG tool for Finnish
+Syntax maker
+=======
+The tool NLG tool for Finnish by [Mika Hämäläinen](https://mikakalevi.com)
 
-For readme, see the [Wiki](https://github.com/DiscoveryGroup/syntaxmaker/wiki) 
+Syntax maker is the natural language generation tool for generating syntactically correct sentences in Finnish automatically. The tool is especially useful in the case of Finnish which has such a high diversity in its morphosyntax. All you need to know are the lemmas and their parts-of-speech and syntax maker will take care of the rest.
+
+For instance, just throw in words `rantaleijona`, `uneksia`, `korkea` and `aalto` and you will get `rantaleijonat uneksivat korkeista aalloista`. So you will get the morphology right automatically! Don't believe me? [Just take a look at this tutorial to find out how.](https://github.com/mikahama/syntaxmaker/wiki/Creating-a-sentence,-the-basics)
+
+
+# Requirements
+1. This tool requires Omorfi, you can download the correct binary version from [http://mikakalevi.com/omorfi](http://mikakalevi.com/omorfi)
+2. HFST `pip install hfst` for more instructions, see my post about [HFST and Python](https://mikalikes.men/using-hfst-on-python/).
+
+# Installing
+You do `pip install syntaxmaker` to install this library.
+After installing it, go to [Creating a sentence, the basics](https://github.com/DiscoveryGroup/syntaxmaker/wiki/Creating-a-sentence,-the-basics) for a quick start guide.
+
+# More information?
+
+Just go ahead and [take a look at the wiki](https://github.com/mikahama/syntaxmaker/wiki) or my [blog post about Syntax maker](https://mikalikes.men/create-finnish-sentences-computationally-in-python-nlg/).

.idea/modules.xml

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-__author__ = 'mikahama'
+__author__ = 'Mika Hämäläinen'
 import csv
 import random
 import os