langfingaz/anki
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

minor doc updates

Browse Source
This commit is contained in:
Damien Elmes 2020-12-11 22:37:12 +10:00
parent b80f33d14d
commit 1da327c725
7 changed files with 22 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -1,10 +1,10 @@
# Anki
[![Build status](https://badge.buildkite.com/c9edf020a4aec976f9835e54751cc5409d843adbb66d043bd3.svg)](https://buildkite.com/ankitects/anki-ci)
This repo contains the source code for the computer version of Anki.
If you'd like to try development builds of Anki but don't feel comfortable
building the code, please see https://betas.ankiweb.net/#/
For more information on building, please see [Development](./docs/development.md).
[![Build status](https://badge.buildkite.com/c9edf020a4aec976f9835e54751cc5409d843adbb66d043bd3.svg)](https://buildkite.com/ankitects/anki-ci)

2
platforms/README.md Normal file
View File

@ -0,0 +1,2 @@
Platform constraints. Currently only used to control wheel filenames
on a per-platform basis.

3
pylib/README.md Normal file
View File

@ -0,0 +1,3 @@
Anki's Python library code is in anki/.
The Rust/Python extension module is in rsbridge/; it references the library defined in ../rslib.

9
pylib/rsbridge/Cargo.toml
View File

@ -19,12 +19,3 @@ features = ["extension-module", "abi3"]
name = "rsbridge"
crate-type = ["cdylib"]
path = "lib.rs"
#[profile.dev]
#opt-level = 2
#debug = 0
#codegen-units = 256
#[profile.dev.package."*"]
#opt-level = 3
#codegen-units = 16

1
qt/README.md Normal file
View File

@ -0,0 +1 @@
Python's Qt GUI is in aqt/

11
rslib/README.md
View File

@ -1 +1,10 @@
To build from scratch, please see https://github.com/ankitects/anki
Anki's Rust code.
backend.proto stores the interfaces used to communicate backend messages between Rust, Python and TypeScript.
Rust editor support is still fairly new, but currently Visual Studio Code + Rust Analyzer seems to be the least bad option. For the latter, you'll want to enable the options to expand proc macros, and run cargo check on startup.
After running 'code .' from this folder, it may take Rust Analyzer a while to become ready, and you may need to save a file to trigger it to run.
You may also want to enable the worker mentioned in ../docs/development.md when compiling from a
terminal.

5
ts/README.md
View File

@ -1,3 +1,6 @@
To add a new dev dependency:
Anki's TypeScript and Sass dependencies. Some TS/JS code is also
stored separately in ../qt/aqt/data/web/.
To add a new dev dependency, use something like:
bazel run @nodejs//:yarn add @rollup/plugin-alias -- -D