anki README

The project's README from github.com/ankitects/anki. As one markdown file: README.md.

Anki

Build Status Documentation Coverage

This repo contains the source code for the computer version of Anki.

About

Anki is a spaced repetition program. Please see the website to learn more.

Getting Started

Contributing

Want to contribute to Anki? Check out the Contribution Guidelines.

For more information on building and developing, please see Development.

Contributors

The following people have contributed to Anki: CONTRIBUTORS

Anki Betas

If you'd like to try development builds of Anki but don't feel comfortable building the code, please see Anki betas.

License

Anki's license: LICENSE

anki (ankitects/anki)

Searching Database…

32.1K ·GitHub
What is this?Anki is a spaced repetition flashcard program that helps you memorize information through scheduled, algorithm-driven reviews.
Is this repo the Anki app itself, or just the source code to build it?This repository holds the source code for the desktop ('computer') version of Anki; it's meant for building the program yourself, not for downloading a finished installer directly from here.
How do I get Anki running from this repo?You follow the Development guide linked from the Contribution Guidelines to compile it, or if you don't want to build it yourself, you can grab one of the prebuilt Anki betas instead.
Is building Anki from source a quick process?The README doesn't give build steps directly - it defers to a separate Development document, which suggests the multi-language (Rust, Python, TypeScript) build isn't a single one-line command.
Is this repo meant for regular users or for developers?It's aimed at developers and contributors; ordinary users looking to just use Anki are pointed to the official website rather than building from source.
Which operating systems does the desktop version run on?The desktop build targets Windows, macOS and Linux.
What tech stack powers Anki's desktop UI?The frontend lives in the ts/ directory and is built with Svelte and Vite on top of a Rust core, with Python used for parts of the build tooling.
How are UI changes tested before merging?The project runs Svelte type-checking (svelte-check), Vitest unit tests, and Playwright end-to-end tests (test:e2e) as part of its workflow.
Can I try new features without building Anki myself?Yes - the README points to prebuilt 'Anki betas' for people who want to try development builds without compiling the code.
Creator
ankitects
Size
52.1 MB
Stars
32.1K
Age
13y
Commits · 90 Days