Add some context from upstream README

This commit is contained in:
flan 2017-10-29 04:21:22 +01:00
parent 6154cfde62
commit bf1bf4de72

View File

@ -1,9 +1,18 @@
ankisyncd
=========
A personal Anki sync server (so you can sync against your own server rather than
AnkiWeb). This version has been modified from dsnopek's Anki Sync Server to
remove the REST API, which makes it possible to drop some dependencies.
[Anki][] is a powerful open source flashcard application, which helps you
quickly and easily memorize facts over the long term utilizing a spaced
repetition algorithm. Anki's main form is a desktop application (for Windows,
Linux and macOS) which can sync to a web version (AnkiWeb) and mobile
versions for Android and iOS.
This is a personal Anki server, which you can sync against instead of
AnkiWeb. It was originally developed to support the flashcard functionality
on Bibliobird, a web application for language learning.
This version has been modified from [dsnopek's Anki Sync Server][] to remove
the REST API, which makes it possible to drop some dependencies.
Installing
----------
@ -39,3 +48,6 @@ like ankisyncd.py) containing the code below and put it in ~/Anki/addons.
Replace 127.0.0.1 with the IP address or the domain name of your server if
ankisyncd is not running on the same machine as Anki.
[Anki]: https://apps.ankiweb.net/
[dsnopek's Anki Sync Server]: https://github.com/dsnopek/anki-sync-server