commit 83270e23284926a0a4da2aef46513b75f623c406 Author: JHubi1 Date: Thu Aug 1 10:08:26 2024 +0200 Added 'Getting Started' diff --git a/Getting-Started.md b/Getting-Started.md new file mode 100644 index 0000000..0af4c01 --- /dev/null +++ b/Getting-Started.md @@ -0,0 +1,35 @@ +This page will guide you through initial setup. + +> [!IMPORTANT] +> This app does not host a Ollama server on device, but rather connects to one and uses its api endpoint. +> You don't know what Ollama is? Learn more at [ollama.com](https://ollama.com/). + +## Installation + +You'll find the latest recommended version of the Ollama App under [the releases tab](https://github.com/JHubi1/ollama-app/releases). Download the APK and install it on your Android device. That's it, now proceed to [Initial Setup](#initial-setup). + +Alternatively, you can also download the app from any of the following stores: + +[](https://apt.izzysoft.de/fdroid/index/apk/com.freakurl.apps.ollama/) + +## Initial Setup + +After installing the app and opening it for the first time, you'll encounter this popup: + +welcome instructions + +Go through the welcome dialog one by one, you should read their content, but you don't have to. + +| ![initial notification](https://github.com/JHubi1/ollama-app/raw/main/assets/screenshots/flutter_02.png) | ![open sidebar](https://github.com/JHubi1/ollama-app/raw/main/assets/screenshots/flutter_26.png) | ![set host input](https://github.com/JHubi1/ollama-app/raw/main/assets/screenshots/flutter_03.png) | +|-|-|-| + +After going through that, you'll get a small snack bar notifying you that you have to set the host. For that, open the sidebar (swipe from the left to right or click the icon in the top left corner) and click on settings. There you'll find all app-related settings, you should go through them, but for the initial setup, only the first one is important. + +In the big host text field, you have to enter the base URL of your instance. The port is required unless the port number matches the protocol (443 for HTTPS or 80 for HTTP). After that, click the save icon right next to the text field. + +To learn more about the host setting, visit [Settings](#host) + +> [!IMPORTANT] +> The Ollama server needs additional steps to be asccessible from without the local machine. To learn more, visit issue #5 + +That's it, you can now just chat. Enter a message into the box at the bottom and click the send icon. \ No newline at end of file