bibliogram/README.md

87 lines
3.3 KiB
Markdown
Raw Permalink Normal View History

2020-01-28 14:43:48 +00:00
# [Bibliogram](https://bibliogram.art)
2020-01-12 12:50:21 +00:00
2020-07-13 13:27:42 +00:00
[![Humane Tech badge.](https://meta.bibliogram.art/art/humane-tech-badge.svg)](https://github.com/humanetech-community/awesome-humane-tech#readme)
2020-07-16 12:00:24 +00:00
![License: AGPL.](https://img.shields.io/badge/license-AGPL-%233897f0)
2020-07-13 13:27:42 +00:00
[![Discussion on Matrix.](https://img.shields.io/matrix/bibliogram:matrix.org?label=%23bibliogram&logo=matrix)](https://matrix.to/#/#bibliogram:matrix.org)
2020-03-25 10:22:54 +00:00
2020-07-13 13:27:42 +00:00
## Navigation
2020-01-26 15:34:10 +00:00
2020-07-13 13:27:42 +00:00
- [Bibliogram project on sourcehut][project]
2020-07-13 13:54:26 +00:00
- Bibliogram code repository
2020-07-13 13:27:42 +00:00
- [Bibliogram issues tracker][issues]
2020-07-19 09:01:01 +00:00
- [Bibliogram development mailing list][list]
2020-07-13 13:27:42 +00:00
- [Updater code repository][updater repo]
- [Full documentation][docs folder]
- [Discussion on Matrix][matrix]
2020-01-26 15:34:10 +00:00
2020-07-13 13:27:42 +00:00
[project]: https://sr.ht/~cadence/bibliogram/
[main repo]: https://git.sr.ht/~cadence/bibliogram
[issues]: https://todo.sr.ht/~cadence/bibliogram-issues
2020-07-19 09:01:01 +00:00
[list]: https://lists.sr.ht/~cadence/bibliogram-devel
2020-07-13 13:27:42 +00:00
[updater repo]: https://git.sr.ht/~cadence/bibliogram-updater
[docs folder]: https://git.sr.ht/~cadence/bibliogram-docs/tree/master/docs
2020-07-09 09:43:40 +00:00
2020-07-13 13:27:42 +00:00
## Bibliogram is an alternative front-end for Instagram.
2020-07-09 09:43:40 +00:00
2020-07-13 13:27:42 +00:00
Bibliogram works without browser JavaScript, has no ads or tracking,
and doesn't urge you to sign up.
2020-07-09 09:43:40 +00:00
2020-07-13 13:27:42 +00:00
See Bibliogram's features: [`docs/Features.md`][features]
2020-07-09 09:43:40 +00:00
2020-07-15 11:38:01 +00:00
[features]: https://git.sr.ht/~cadence/bibliogram-docs/tree/master/docs/Features.md
2020-07-09 09:43:40 +00:00
2020-07-13 13:27:42 +00:00
Join the Bibliogram discussion room on Matrix:
[#bibliogram:matrix.org][matrix]
2020-07-09 09:43:40 +00:00
2020-07-13 13:27:42 +00:00
[matrix]: https://matrix.to/#/#bibliogram:matrix.org
2020-07-09 09:43:40 +00:00
2020-07-13 13:27:42 +00:00
See also: [Invidious, a front-end for YouTube.][invidious repo]
2020-07-09 09:43:40 +00:00
2020-11-14 13:18:01 +00:00
[invidious repo]: https://github.com/iv-org/invidious
2020-07-09 09:43:40 +00:00
2020-07-13 13:27:42 +00:00
## Instances
2020-07-09 09:43:40 +00:00
2020-07-13 13:27:42 +00:00
The official instance is on
[https://bibliogram.art](https://bibliogram.art).
2020-07-09 09:43:40 +00:00
2020-07-13 13:27:42 +00:00
Community instances are listed in [`docs/Instances.md`][instances].
Submit a patchset to add your own instance to that list.
2020-07-09 09:43:40 +00:00
2020-07-15 11:38:01 +00:00
[instances]: https://git.sr.ht/~cadence/bibliogram-docs/tree/master/docs/Instances.md
2020-07-09 09:43:40 +00:00
2020-07-13 13:27:42 +00:00
## Installing
2020-07-09 09:43:40 +00:00
2020-07-13 13:27:42 +00:00
See [`docs/Installing (basic).md`][basic] and
[`docs/Installing (extended).md`][extended].
2020-07-15 11:38:01 +00:00
[basic]: https://git.sr.ht/~cadence/bibliogram-docs/tree/master/docs/Installing%20%28basic%29.md
[extended]: https://git.sr.ht/~cadence/bibliogram-docs/tree/master/docs/Installing%20%28extended%29.md
2020-04-14 16:01:11 +00:00
2020-11-14 13:30:57 +00:00
## Contributing
- [Learn how to submit a patchset][patchset docs]
- [Translate for your language][translating]
[patchset docs]: https://git.sr.ht/~cadence/bibliogram-docs/tree/master/docs/Submitting%20a%20patchset.md
[translating]: https://git.sr.ht/~cadence/bibliogram-docs/tree/master/docs/Translating.md
2020-02-22 11:27:23 +00:00
## Credits & license information
2020-01-28 14:43:48 +00:00
2020-07-13 13:27:42 +00:00
All of Bibliogram'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.
2020-11-14 13:30:57 +00:00
[The documentation uses the Unlicense](https://unlicense.org/).
2020-07-13 13:27:42 +00:00
Site banner by [TheFrenchGhosty](https://github.com/TheFrenchGhosty),
[CC BY-NC-SA 4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/)
2020-02-22 11:27:23 +00:00
2020-07-13 13:27:42 +00:00
Site font is [Bariol](http://atipofoundry.com/fonts/bariol) by
[atipo foundry](http://atipofoundry.com/), located in
`/src/site/html/static/fonts` in the main repo. Proprietary license,
used with permission. See http://atipofoundry.com/license, section
"webfont license".