Skip to content

quickstart.md

Latest commit

 

History

History
49 lines (32 loc) · 1.57 KB

quickstart.md

File metadata and controls

49 lines (32 loc) · 1.57 KB

Quick Start Guide

Get Yarrand up and running in minutes!

Prerequisites

  • Android 8.0 or higher
  • A running Yarr server (self-hosted or accessible)

Installation & Quick Start

This quickstart is a short guide — for full details see README.md.

Preferred build shortcuts use the project's Makefile which wraps common Gradle tasks.

Build and install (preferred):

# Debug build + rename
make debug-rename
# Install to connected device
make install-debug

# Release build (signed) and rename
make release-rename
# Install signed release on device
make install-release

If you prefer to run Gradle directly, the docs/building.md has the commands.

First-Time Setup

  1. Open Yarrand. If Server URL is not configured you'll be taken to Settings.
  2. Enter your Yarr server URL (include http:// or https://).
  3. Save settings. The app will load the configured server.

Important settings

  • Keep me logged in — persist authentication cookies across restarts.
  • Allow self-signed certificates — enable to connect to local dev servers using autofirmed TLS (disabled by default).
  • External link handling — external links can be opened in an external browser or blocked (configurable).

Basic usage

  • Back button: navigates within Yarr's SPA (article → articles → feeds). If at the home feeds list, the back button exits.
  • Toolbar: Home (go to configured server start), Refresh (trigger server-side feed refresh via API and poll status).

For troubleshooting, advanced build options, and the release process, see the docs/ files and README.md.