From 41e7c1533c3dbbc6ae6e26f40893054345395a53 Mon Sep 17 00:00:00 2001 From: Cohee Date: Wed, 7 Jun 2023 20:47:08 +0300 Subject: [PATCH] Update readme.md --- .github/readme.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/.github/readme.md b/.github/readme.md index dfbc77591..ca27e24d9 100644 --- a/.github/readme.md +++ b/.github/readme.md @@ -14,6 +14,15 @@ Tavern is a user interface you can install on your computer (and Android phones) SillyTavern is a fork of TavernAI 1.2.8 which is under more active development and has added many major features. At this point, they can be thought of as completely independent programs. +### Branches + +SillyTavern is being developed using a two-branch system to ensure a smooth experience for all users. + +* main - This is the most stable and recommended branch, updated only when major releases are pushed. It's perfect for the majority of users. 🌟 **Recommended for most users.** +* dev - This branch has the latest features, but be cautious as it may break at any time. ⚠️ **Not recommended for casual use.** + +If you're not familiar with using the git CLI or don't understand what a branch is, don't worry! The main branch is always the preferable option for you. + ### What do I need other than Tavern? On its own Tavern is useless, as it's just a user interface. You have to have access to an AI system backend that can act as the roleplay character. There are various supported backends: OpenAPI API (GPT), KoboldAI (either running locally or on Google Colab), and more. You can read more about this in [the FAQ](faq.md).