+ table of contents

This commit is contained in:
nicobo 2021-03-18 22:40:42 +01:00
parent 22ec567660
commit a0aa86c2e1
No known key found for this signature in database
GPG key ID: 2581E71C5FA5285F
2 changed files with 43 additions and 0 deletions

View file

@ -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)
<!-- toc -->
- [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)
<!-- tocstop -->
## Basic development

View file

@ -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)
<!-- toc -->
- [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)
<!-- tocstop -->
## About