diff --git a/README.md b/README.md index 7acb0660f..2ed79c620 100644 --- a/README.md +++ b/README.md @@ -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) diff --git a/platforms/README.md b/platforms/README.md new file mode 100644 index 000000000..651ff8de4 --- /dev/null +++ b/platforms/README.md @@ -0,0 +1,2 @@ +Platform constraints. Currently only used to control wheel filenames +on a per-platform basis. diff --git a/pylib/README.md b/pylib/README.md new file mode 100644 index 000000000..d9507f931 --- /dev/null +++ b/pylib/README.md @@ -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. diff --git a/pylib/rsbridge/Cargo.toml b/pylib/rsbridge/Cargo.toml index cf2847d19..0bccffb81 100644 --- a/pylib/rsbridge/Cargo.toml +++ b/pylib/rsbridge/Cargo.toml @@ -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 diff --git a/qt/README.md b/qt/README.md new file mode 100644 index 000000000..5e91217d7 --- /dev/null +++ b/qt/README.md @@ -0,0 +1 @@ +Python's Qt GUI is in aqt/ diff --git a/rslib/README.md b/rslib/README.md index a318d199f..fe18e9206 100644 --- a/rslib/README.md +++ b/rslib/README.md @@ -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. diff --git a/ts/README.md b/ts/README.md index aa49bb30e..af7c5e296 100644 --- a/ts/README.md +++ b/ts/README.md @@ -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