From 152b175a834ba5458f66bf449689169e2a8165f9 Mon Sep 17 00:00:00 2001 From: "michael.jaumann" Date: Fri, 8 Nov 2024 16:37:00 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=A7=BE=20doku=20update?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 38 ++++++++++++++++++++++++-------------- 1 file changed, 24 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index a36e9fab..bb799fd5 100644 --- a/README.md +++ b/README.md @@ -10,23 +10,34 @@ [![Made with love by it@M][made-with-love-shield]][itm-opensource] +[![Gitmoij][gitmoij-shield]][gitmoij] [![GitHub license][license-shield]][license] [![GitHub release version][github-release-shield]][releases] +[![uv][uv-shield]][uv] ![Supported python versions][python-versions-shield] +![Supported npm versions][npm-versions-shield] [made-with-love-shield]: https://img.shields.io/badge/made%20with%20%E2%9D%A4%20by-it%40M-yellow?style=for-the-badge [license-shield]: https://img.shields.io/github/license/it-at-m/itm-prettier-codeformat?style=for-the-badge -[github-release-shield]: https://img.shields.io/github/v/release/it-at-m/mucgpt?style=for-the-badge +[github-release-shield]: https://img.shields.io/github/v/release/it-at-m/mucgpt?style=for-the-badge&color=orange [python-versions-shield]: https://img.shields.io/badge/python-3.10|%203.11%20|%203.12-blue?style=for-the-badge +[gitmoij-shield]: https://img.shields.io/badge/gitmoij-😜😍-yellow?style=for-the-badge +[npm-versions-shield]: https://img.shields.io/badge/node-20+-blue?style=for-the-badge +[uv-shield]: https://img.shields.io/badge/⚡-uv-blue?style=for-the-badge [itm-opensource]: https://opensource.muenchen.de/ [license]: https://github.com/it-at-m/mucgpt/blob/main/LICENSE [releases]: https://github.com/it-at-m/mucgpt/releases -MUCGPT provides a web interface based on a large language model (LLM). The interface currently connects to one or multiple OpenAI-compatible LLM-enpdoints, which allows users to chat, summarise text, brainstorm some ideas and translate a text to plain or easy language. The chat function allows text to be generated and refined in several steps. Summarizing allows PDFs or text to be shortened and made more concise. Brainstorming allows users to create mind maps for different topics. Simplified language allows the user to translate a text into plain or easy language, resulting in a more understandable and easier-to-read text. The included IAC files for Azure make it easy to deploy the project in just a few steps. +[gitmoij]: https://gitmoji.dev/ +[uv]: https://github.com/astral-sh/uv -Why should you use MUCGPT? See for yourself: - -![Essay of MUCGPT to convince the user to use it!](/docs/convince-the-user.png) +MUCGPT provides a web interface based on a large language model (LLM). The interface currently connects to one or multiple OpenAI-compatible LLM-enpdoints, which allows users to chat, summarise text, brainstorm some ideas and translate a text to plain or easy language. The chat function allows text to be generated and refined in several steps. Summarizing allows PDFs or text to be shortened and made more concise. Brainstorming allows users to create mind maps for different topics. Simplified language allows the user to translate a text into plain or easy language, resulting in a more understandable and easier-to-read text. + +In addition custom GPTs can be generated and saved. A own GPT is an assistant for a specific task with an custom system prompt. + +Why should you use MUCGPT? See for yourself: + +![Essay of MUCGPT to convince the user to use it!](/docs/convince-the-user.png) ## Built With @@ -78,13 +89,13 @@ uv pip compile pyproject.toml -o requirements-dev.txt --python-version