diff --git a/README.md b/README.md index e69de29b..87bf82e8 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,18 @@ +# Exasol Advanced Analytics Framework + +**This project is at an early development stage.** + +Framework for building complex data analysis algorithms with Exasol. + + +## Information for Users + +- [User Guide](doc/user_guide/user_guide.md) +- [System Requirements](doc/system_requirements.md) +- [Design](doc/design.md) +- [License](LICENSE) + +## Information for Developers + +- [Developers Guide](doc/developer_guide/developer_guide.md) + diff --git a/doc/changes/changes_0.1.0.md b/doc/changes/changes_0.1.0.md index 7fa2d4c5..1032f90f 100644 --- a/doc/changes/changes_0.1.0.md +++ b/doc/changes/changes_0.1.0.md @@ -5,3 +5,14 @@ ### Features + + - #1: Added the initial setup of the project + +### Bug Fixes + + - #8: Renamed master branch to main + +### Documentation + + - #9: Added README file + \ No newline at end of file diff --git a/setup.py b/setup.py index 74dba41d..36ff5b0a 100644 --- a/setup.py +++ b/setup.py @@ -11,7 +11,7 @@ 'name': 'exasol-advanced-analytics-framework', 'version': '0.1.0', 'description': 'Framework for building complex data analysis algorithms with Exasol', - 'long_description': '', + 'long_description': '# Exasol Advanced Analytics Framework\n\n**This project is at an early development stage.**\n\nFramework for building complex data analysis algorithms with Exasol.\n\n\n## Information for Users\n\n- [User Guide](doc/user_guide/user_guide.md)\n- [System Requirements](doc/system_requirements.md)\n- [Design](doc/design.md)\n- [License](LICENSE)\n\n## Information for Developers\n\n- [Developers Guide](doc/developer_guide/developer_guide.md)\n\n', 'author': 'Umit Buyuksahin', 'author_email': 'umit.buyuksahin@exasol.com', 'maintainer': None,