From 448d538d212b82204c96d53a7b87bd8ed30fff1c Mon Sep 17 00:00:00 2001 From: Sven Heidemann Date: Wed, 31 Mar 2021 15:38:26 +0200 Subject: [PATCH] Updated reame --- README.md | 104 +++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 103 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index dec1870d..5f5031b8 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,104 @@ -# sh_common_py_lib +

CPL - Common python library

+ + +

+ +
+ + CPL is a development platform for python server applications +
using Python.
+
+

+ +## Table of Contents + +
    +
  1. + Getting Started + +
  2. +
  3. Roadmap
  4. +
  5. Contributing
  6. +
  7. License
  8. +
  9. Contact
  10. +
+ + + +## Getting Started + +[Get started with CPL][quickstart]. + +### Prerequisites + +- Install [python] which includes [Pip installs packages][pip] + +### Installation + +Install the cpl package +```sh +pip install sh_cpl --extra-index-url https://pip.sh-edraft.de +``` + +Create workspace: +```sh +cpl new +``` + +Run the application: +```sh +cd +cpl start +``` + + + +## Roadmap + +See the [open issues](https://git.sh-edraft.de/sh-edraft.de/sh_common_py_lib/issues) for a list of proposed features (and known issues). + + + + +## Contributing + +### Contributing Guidelines + +Read through our [contributing guidelines][contributing] to learn about our submission process, coding rules and more. + +### Want to Help? + +Want to file a bug, contribute some code, or improve documentation? Excellent! Read up on our guidelines for [contributing][contributing]. + + + + +## License + +Distributed under the MIT License. See [LICENSE] for more information. + + + + +## Contact + +Sven Heidemann - sven.heidemann@sh-edraft.de + +Project link: [https://git.sh-edraft.de/sh-edraft.de/sh_common_py_lib](https://git.sh-edraft.de/sh-edraft.de/sh_common_py_lib) + + +[pip_url]: https://pip.sh-edraft.de +[python]: https://www.python.org/ +[pip]: https://pypi.org/project/pip/ + + +[project]: https://git.sh-edraft.de/sh-edraft.de/sh_common_py_lib +[quickstart]: quickstart.md +[contributing]: contributing.md +[license]: LICENSE + +[contributors-url]: contributors