New readme

Author: francisco-ortin

LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2020, Computational Reflection
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -1,3 +1,52 @@
-# Cnerator
-
-C code generator
+# Cnerator
+
+
+[![License](https://img.shields.io/github/license/ComputationalReflection/cnerator)](LICENSE)
+[![Latest stable release](https://img.shields.io/github/v/release/ComputationalReflection/cnerator?label=current-version)](https://github.com/ComputationalReflection/cnerator/releases)
+<img alt="Python version" src="https://img.shields.io/github/pipenv/locked/python-version/computationalreflection/cnerator">
+<img alt="Code size" src="https://img.shields.io/github/languages/code-size/computationalreflection/cnerator">
+<img alt="Repo size" src="https://img.shields.io/github/repo-size/computationalreflection/cnerator">
+
+
+
+Cnerator is a C source code generation tool. Generated programs can be compiled with any standard ANSI C compiler. 
+The user may define different parameters such as the number of function to be generated or the probabilities of all
+the different syntactic constructs (e.g., the average number of statements in a function, expression types, 
+number and types of local variables, and the kind of syntactic constructs to be generated). 
+
+Generated programs fulfill the type rules of the C programming language, so they are compiled without errors. 
+Using the different parameters, the user can utilize Cnerator to create a huge amount of synthetic C programs,
+necessary in common "Big Code" scenarios.
+
+## Command line options:
+
+``` text
+usage: cnerator.py [-h] [-w PATH] [-o NAME] [-p AMOUNT] [-r RECURSION]
+                   [-vst VISITORS] [-v] [-d]
+
+Generates a compilable C program
+
+optional arguments:
+  -h, --help            show this help message and exit
+  -w PATH, --working-dir PATH
+                        Working directory (default: out)
+  -o NAME, --output NAME
+                        C output file name, without the .c extension (default:
+                        main)
+  -p AMOUNT, --parts AMOUNT
+                        Split the program in different C files (default: 2)
+  -r RECURSION, --recursion RECURSION
+                        Python recursion limit (default: 50000)
+  -vst VISITORS, --visitors VISITORS
+                        Semicolon-separated list of visitors, in order (e.g.,
+                        visitors.func_to_proc;visitors.return_instrumentation)
+                        (default: )
+  -v, --verbose         Verbose messages (default: False)
+  -d, --debug           Generate debug info (call graph and struct structure)
+                        in .dot files (default: False)
+```
+
+
+## License
+
+[BSD 3 clause license](LICENSE)

main.py renamed to cnerator.py

@@ -19,34 +19,39 @@
 __version = "0.1.0"
 __maintainer = __contacts[0][0]
 __email = __contacts[0][1]
-__contact =__email
+__contact = __email
 __status = "Alpha"
 __url = "https://github.com/Kerrigan29a/cnerator"
 
 
 def read_lines(file_name):
     file = open(os.path.join(os.path.dirname(__file__), file_name))
-    lines = "".join(file.readlines())
+    lines = file.readlines()
     file.close()
     return lines
 
 
+def read_file(file_name):
+    lines = read_lines(file_name)
+    return "".join(lines)
+
+
 setup(
     name='cnerator',
     version=__version,
     description='C source code generator',
-    long_description=read_lines("README.md"),
-    long_description_content_type = "text/markdown",
+    long_description=read_file("README.md"),
+    long_description_content_type="text/markdown",
     author=__author,
     author_email=__email,
     maintainer=__maintainer,
     maintainer_email=__email,
     url=__url,
     download_url=__url,
     license=__license,
-    keywords="c clang code generator",
+    keywords="C language lang code generator",
     install_requires=read_lines("requirements.txt"),
-    # dependency_links=[],
+    #dependency_links=['singledispatch'],
     packages=find_packages(),
     platforms='any',
     classifiers=[