update readme

This commit is contained in:
Damien Elmes 2016-07-04 17:15:03 +10:00
parent 85665bc18d
commit ef89a0dadd
2 changed files with 10 additions and 34 deletions

34
README
View file

@ -1,34 +0,0 @@
Anki
-------------------------------------
Prerequisites
---------------
To install the prerequisites on Ubuntu/Debian, please use the following
command:
sudo apt-get install python-qt4 mplayer lame libportaudio2 python-sqlalchemy
If you're on another distribution the packages may be named differently, so
please consult your package manager.
Your Python version will need to be 2.6 or 2.7 (not 3+), and both Qt and PyQt
need to be 4.7 or later.
Installation & Running
------------------------
Anki does not need installing, and can be run from the directory it is
extracted to. If you extracted it to ~/anki-2.0 for example, you can run Anki
by simply typing ~/anki-2.0/runanki in a terminal.
If you'd like to install it system wide, change to the folder you extracted it
to, and run 'sudo make install'. If you need to uninstall Anki in the future,
you can do so by typing 'sudo make uninstall'.
More information
-----------------
For more information and the latest version, please see the website at:
http://ankisrs.net/

10
README.md Normal file
View file

@ -0,0 +1,10 @@
Anki
-------------------------------------
This is the development branch of Anki. For stable builds, please see
http://ankisrs.net
[![Build Status](https://travis-ci.org/dae/anki.svg?branch=master)](https://travis-ci.org/dae/anki)
[![Coverage Status](https://coveralls.io/repos/github/dae/anki/badge.svg?branch=master)](https://coveralls.io/github/dae/anki?branch=master)