From b8f33459afa18f48689bc015e63b368131f8db2c Mon Sep 17 00:00:00 2001 From: JHubi1 Date: Mon, 5 Aug 2024 14:39:03 +0200 Subject: [PATCH] Updated Contributing (markdown) --- Contributing.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/Contributing.md b/Contributing.md index 1354656..abc76e5 100644 --- a/Contributing.md +++ b/Contributing.md @@ -16,10 +16,11 @@ In case the language you're looking for isn't listed, you can check if the devel Now it's going to get interesting. The app is built in a way so you can easily create custom-builds. Currently, there are these values that can be customized: -``` +```dart // use host or not, if false dialog is shown const useHost = false; -// host of ollama, must be accessible from the client, without trailing slash, will always be accepted as valid +// host of ollama, must be accessible from the client, without trailing slash +// ! will always be accepted as valid, even if [useHost] is false const fixedHost = "http://example.com:11434"; // use model or not, if false selector is shown const useModel = false; @@ -33,13 +34,13 @@ const allowSettings = true; const allowMultipleChats = true; ``` -They can be found at the top of `lib/main.dart`. `useHost` and `useModel` decide whether you want `fixedHost` and `fixedModel` to control anything. `fixedHost` and `fixedModel` decide about the value that has to be used. That can be practical in case you try to create an app specific to your instance. +They can be found at the top of `lib/main.dart`. `useHost` and `useModel` decide whether you want `fixedHost` and `fixedModel` to control anything. `fixedHost` and `fixedModel` decide about the value that has to be used. That can be practical in case you try to create an app specific to your instance. The value that is chosen for `fixedHost` is always accepted as valid, even if the host is not accessible from that port. This cannot be changed. `recommendedModels` is a list of models that will be listed as recommended in the [Model Selector](#model-selector). They are more like personal preferences. If empty, no model will be preferred. -`allowSettings` will disable the settings screen. But it will also disable the welcome dialog at first startup and the ability to rename chats. +`allowSettings` will disable the settings screen. But it will also skip the welcome dialog at first startup and remove the ability to rename chats. For this to be available, `useHost` must be `true` or the build will not be in a working state. -`allowMultipleChats` simply removes the `New Chat` option in the [Side Menu](#side-menu). And will load up the only available chat on app startup. +`allowMultipleChats` simply removes the `New Chat` option in the [Side Menu](#side-menu) and will load up the only available chat on app startup. ### Actually Building