add simplified readme for the rtd

This commit is contained in:
Evgenii Alekseev 2022-04-18 03:04:16 +03:00
parent c9ee470ee2
commit 13dfbc55f6

34
README.rst Normal file
View File

@ -0,0 +1,34 @@
ArcH Linux ReposItory MANager
=============================
Wrapper for managing custom repository inspired by `repo-scripts <https://github.com/arcan1s/repo-scripts>`_.
Features
--------
* Install-configure-forget manager for own repository.
* Multi-architecture support.
* VCS packages support.
* Sign support with gpg (repository, package, per package settings).
* Synchronization to remote services (rsync, s3 and github) and report generation (email, html, telegram).
* Dependency manager.
* Ability to patch AUR packages and even create package from local PKGBUILDs.
* Repository status interface with optional authorization and control options:
.. image:: web.png
:target: web.png
:alt: web interface
Installation and run
--------------------
For installation details please refer to the `documentation <docs/setup.md>`_. For command help, ``--help`` subcommand must be used. Subcommands have own help message as well. The package also provides a `man page <docs/ahriman.1>`_.
Configuration
-------------
Every available option is described in the `documentation <docs/configuration.md>`_.
`FAQ <docs/faq.md>`_
------------------------