From a0aa86c2e1feff6711fb96a7b180dde72559b7d3 Mon Sep 17 00:00:00 2001 From: nicobo Date: Thu, 18 Mar 2021 22:40:42 +0100 Subject: [PATCH] + table of contents --- Develop.md | 18 ++++++++++++++++++ README.md | 25 +++++++++++++++++++++++++ 2 files changed, 43 insertions(+) diff --git a/Develop.md b/Develop.md index 039a84a..49496f6 100644 --- a/Develop.md +++ b/Develop.md @@ -5,6 +5,24 @@ [![Docker debian][docker-debian-size] ![Docker signal-debian][docker-signal-debian-size] ![Docker alpine][docker-alpine-size]](https://hub.docker.com/r/nicolabs/nicobot/tags) + + +- [Basic development](#basic-development) + * [PyPi upload](#pypi-upload) + * [Automation for PyPi](#automation-for-pypi) +- [Docker build](#docker-build) + * [Automation for Docker Hub](#automation-for-docker-hub) + + [Tagging strategy](#tagging-strategy) + * [Docker build process overview](#docker-build-process-overview) + * [Why no image is available for arch x ?](#why-no-image-is-available-for-arch-x-) + * [Docker image structure](#docker-image-structure) +- [Deploying on AWS](#deploying-on-aws) +- [Versioning](#versioning) +- [Building signal-cli](#building-signal-cli) +- [Resources](#resources) + + + ## Basic development diff --git a/README.md b/README.md index 79b26d6..86431cb 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,32 @@ Docker images : [![Build and publish to Docker Hub][dockerhub-shield]][dockerhub-link] [![Docker debian][docker-debian-size] ![Docker signal-debian][docker-signal-debian-size] ![Docker alpine][docker-alpine-size]](https://hub.docker.com/r/nicolabs/nicobot/tags) + +- [About](#about) +- [Requirements & installation](#requirements--installation) + * [Python package installation](#python-package-installation) + * [Installation from source](#installation-from-source) + * [Docker usage](#docker-usage) +- [How to use the bots](#how-to-use-the-bots) + * [Transbot usage](#transbot-usage) + * [Quick start](#quick-start) + + [Main configuration options and files](#main-configuration-options-and-files) + * [Askbot usage](#askbot-usage) + + [Main configuration options](#main-configuration-options) + + [Examples](#examples) + * [Generic instructions](#generic-instructions) + + [Common options](#common-options) + + [Configuration file : config.yml](#configuration-file--configyml) + + [Using the Jabber/XMPP backend](#using-the-jabberxmpp-backend) + + [Using the Signal backend](#using-the-signal-backend) +- [Common issues](#common-issues) + * [Couldn't load the OMEMO object](#couldnt-load-the-omemo-object) + * [ERROR No appropriate login method](#error---no-appropriate-login-method) + * [Authorization failed!](#authorization-failed) +- [External resources](#external-resources) + + ## About