Prettier Readme

[sezanzeb]

I reorganized the readme a bit, because it was really huge.

There are two subpages usage.md and installation.md now. Making it easier to find things.

There is also a screenshot, that helps to communicate what this repository is about.

On the top there is what seems to be the official logo of KoboldAI.

See https://github.com/sezanzeb/KoboldAI-Client/tree/pretty-readme#readme

[sezanzeb]

I'd recommend setting some tags for the repo by the way, and a short description, using the gear icon on the top right

Possible tags: chatbot, nlp, gpt

Possible short description: A browser-based front-end for AI-assisted writing with multiple local & remote AI models

---

[henk717]

I do prefer to have the installation and usage directly visible so people don't read over the link.
I assume the same design is possible with a link inside the same page?

[sezanzeb]

I do prefer to have the installation and usage directly visible so people don't read over the link.

I would also usually prefer that and have it like that in my own repos. But in this case they are quite long and there are many sections.

I also think this way of designing a readme file makes those links hard to overlook.

I think as a user I wouldn't mind having them on a separate page, as long as it is clearly visible where they are, and if it helps making things more structured.

Are you sure about that?

[sezanzeb]

The

umamba.exe is bundled for convenience because we observed that many of our users had trouble with command line download methods, it is not part of our project and does not fall under the AGPL license. It is licensed under the BSD-3-Clause license. Other files with differing licenses will have a reference or embedded version of this license within the file. It has been sourced from https://anaconda.org/conda-forge/micromamba/files and its source code can be found here : https://github.com/mamba-org/mamba/tree/master/micromamba

section should probably go into LICENSE.md.

But since the project page says it is

I guess this might still be difficult.

But I'm not a lawyer.

It probably would be best to just ask the mamba people how they would prefer it.

[sezanzeb]

I changed a few things, please have another look at https://github.com/sezanzeb/KoboldAI-Client/tree/pretty-readme#readme

[sezanzeb]

Alternative: https://github.com/sezanzeb/KoboldAI-Client/tree/pretty-readme-alternative#readme

But yeah, I can leave everything in readme.md and just change the top, with links pointing down to the sections. That would also be already better than how it is now.