GitHub/Anki
1
0
Fork 0
mirror of https://github.com/ankitects/anki.git synced 2025-09-19 06:22:22 -04:00
Code Issues Projects Releases Packages 1 Wiki Activity Actions

doc updates

Browse source 
thanks to Robert: https://github.com/ankitects/anki/pull/756

closes #756
This commit is contained in:
Damien Elmes 2020-09-07 16:03:21 +10:00
parent 0f1e277c59
commit d4edbd5b11
2 changed files with 23 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
CONTRIBUTORS
View file

@ -13,6 +13,16 @@ licensed under the BSD 3 clause license. If any pull request you make contains
code that you don't own the copyright to, you agree to make that clear when code that you don't own the copyright to, you agree to make that clear when
submitting the request. submitting the request.
When submitting a pull request, GitHub Actions will check that the Git email you
are submitting from matches the one you used to edit this file. A common issue
is adding yourself to this file using the username on your computer, but then
using GitHub to rebase or edit a pull request online. This will result in your
Git email becoming something like user@noreply.github.com. To prevent the
automatic check from failing, you can edit this file again using GitHub's online
editor, making a trivial edit like adding a space after your name, and then pull
requests will work regardless of whether you create them using your computer or
GitHub's online interface.
For users who previously confirmed the license of their contributions on the For users who previously confirmed the license of their contributions on the
support site, it would be great if you could add your name below as well. support site, it would be great if you could add your name below as well.

18
README.development
View file

@ -26,7 +26,8 @@ $ pyenv/bin/python -c 'import aqt; aqt.run()'
Building from source Building from source
-------------------- --------------------
To start, make sure you have the following installed: You will need the following dependencies. Some OS-specific tips on installing
them are further down this document.
- Python 3.7+ - Python 3.7+
- portaudio - portaudio
@ -44,14 +45,14 @@ To start, make sure you have the following installed:
- git - git
- curl - curl
The build scripts assume a UNIX-like environment, so on Windows you will
need to use WSL or Cygwin to use them.
Once you've installed the above components, execute ./run in this repo, Once you've installed the above components, execute ./run in this repo,
which will build the subcomponents, and start Anki. Any arguments included which will build the subcomponents, and start Anki. Any arguments included
on the command line will be passed on to Anki. The first run will take on the command line will be passed on to Anki. The first run will take
quite a while to download and build everything - please be patient. quite a while to download and build everything - please be patient.
Don't name the Git checkout ~/Anki or ~/Documents/Anki, as those folders
were used on old Anki versions and will be automatically moved.
Before contributing code, please read README.contributing. Before contributing code, please read README.contributing.
If you'd like to contribute translations, please see the translations section If you'd like to contribute translations, please see the translations section
@ -67,6 +68,10 @@ Subcomponents
- proto contains the interface used to communicate between different - proto contains the interface used to communicate between different
languages. languages.
The pyenv folder is created when running make for the first time.
It is a Python virtual environment that contains Anki's libraries
and all the required depenencies.
Makefile Makefile
-------------- --------------
@ -99,7 +104,7 @@ Install Python 3.7+ if it's not installed.
Install other dependencies: Install other dependencies:
``` ```
sudo apt install portaudio19-dev mpv lame npm rsync gcc gettext git curl sudo apt install portaudio19-dev mpv lame npm rsync gcc gettext git curl python3-dev python3-venv libxcb-xinerama0
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
source $HOME/.cargo/env source $HOME/.cargo/env
wget https://github.com/protocolbuffers/protobuf/releases/download/v3.11.4/protoc-3.11.4-linux-x86_64.zip wget https://github.com/protocolbuffers/protobuf/releases/download/v3.11.4/protoc-3.11.4-linux-x86_64.zip
@ -120,6 +125,9 @@ $ brew link gettext --force
Windows users (using Visual Studio) Windows users (using Visual Studio)
---------- ----------
The build scripts assume a UNIX-like environment, so on Windows you will
need to use WSL or Cygwin to use them.
User-contributed instructions for building using Cygwin: User-contributed instructions for building using Cygwin:
1. Download and install Cygwin and put its `/bin/` directory on your system path (This PC > Properties > Advancded system settings > Environment Variables > double-click Path > New). 1. Download and install Cygwin and put its `/bin/` directory on your system path (This PC > Properties > Advancded system settings > Environment Variables > double-click Path > New).