~akspecs/aqoli

bf7a649aeba2a16233e994adcf854b71a842d032 — Andrei Khartchenko 8 months ago f961eb3 master
add README.md
1 files changed, 74 insertions(+), 0 deletions(-)

A README.md
A README.md => README.md +74 -0
@@ 0,0 1,74 @@
# aqoli - Aggregated Quality of Life Indices

![License: AGPL.](https://img.shields.io/badge/license-AGPL-%233897f0)
[![Discussion on Matrix.](https://img.shields.io/matrix/2021_fall_cs195_general:matrix.org?label=%23aqoli&logo=matrix)](https://matrix.to/#/#2021_fall_cs195_general:matrix.org)

## Navigation

- [aqoli project on sourcehut (to be fully migrated)][project]
- › aqoli website code repository
- [numbeo-scraping code repository][numbeo-scraping repo]
- [Issue tracker][trackers]
- [Mailing lists][lists]
- [Full documentation][docs folder]
- [Discussion on Matrix][matrix]

[project]: https://sr.ht/~akspecs/aqoli
[aqoli website repo]: https://github.com/ak-ccsf/acoli
[numbeo-scraping repo]: https://git.sr.ht/~akspecs/numbeo-scraping
[trackers]: https://sr.ht/~akspecs/aqoli/trackers
[lists]: https://sr.ht/~akspecs/aqoli/lists
[docs folder]: https://git.sr.ht/~akspecs/aqoli/tree/master/docs

## aqoli - a front-end web interface to quality of life living metrics

browse and compare aggregated quality of life indices with the help of
this website

See aqoli's features: [`docs/features.md`][features]

[features]: https://git.sr.ht/~akspecs/aqoli/tree/master/docs/features.md

Join the aqoli/numbeo scraping discussion room on Matrix:
[#2021 fall cs195 general:matrix.org][matrix]

[matrix]: https://matrix.to/#/#2021_fall_cs195_general:matrix.org

See also: [numbeo-scraping, a set of scrapy spiders that crawl numbeo.com.][numbeo-scraping repo]

[numbeo-scraping repo]: https://git.sr.ht/~akspecs/numbeo-scraping

## Instances

The official instance is on
[https://example.com](https://example.com).

Community instances are listed in [`docs/instances.md`][instances].
Submit a patch to add your own instance to that list.

[instances]: https://git.sr.ht/-akspecs/aqoli/tree/master/docs/instances.md

## Installing

See [`docs/installing_basic.md`][basic] and
[`docs/installing_extended.md`][extended].

[basic]: https://git.sr.ht/~akspecs/aqoli/tree/master/docs/installing_basic.md
[extended]: https://git.sr.ht/~akspecs/aqoli/tree/master/docs/installing_extended.md

## Contributing

- [Learn how to submit a patch][patch docs]

[patch docs]: https://git.sr.ht/~akspecs/aqoli/tree/master/docs/submitting_a_patch.md

## Credits & license information

All of aqoli's code uses the
[AGPL 3.0 license](https://choosealicense.com/licenses/agpl-3.0/). In
short, this means that if you make any modifications to the code and
then publish the result (e.g. by hosting the result on a webserver),
you must publicly distribute your changes and declare that they also
use AGPL 3.0.

[The documentation uses the Unlicense](https://unlicense.org/).