Skip to content

Commit

Permalink
Rename easy-testing, tweak docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dae committed Jun 21, 2022
1 parent 57769a9 commit 2768c42
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 14 deletions.
11 changes: 3 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,9 @@ Adapter allowing AnkiDroid to leverage Anki Desktop's Rust-based business logic

## How to use it in a project

Pre-built version:

```gradle
implementation "io.github.david-allison-1:anki-android-backend:0.1.13-anki2.1.53"
testImplementation "io.github.david-allison-1:anki-android-backend-testing:0.1.13-anki2.1.53"
```

See ./docs for info on building a version for testing.
AnkiDroid uses a pre-built version of this library, and includes it in AnkiDroid/build.gradle.
To build a local version of this library and tell AnkiDroid to use it, please see the instructions
in docs/TESTING.md

## Folders

Expand Down
2 changes: 1 addition & 1 deletion build-current.sh
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/bin/bash
#
# Builds for the current architecture only. See docs/easy-testing.md
# Builds for the current architecture only. See docs/TESTING.md
#

set -e
Expand Down
15 changes: 10 additions & 5 deletions docs/easy-testing.md → docs/TESTING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# Testing changes with AnkiDroid on an X86_64 sim (Linux)

It is possible to limit the build to the current architecture, to avoid having
to use Docker or to cross-compile for multiple platforms.

A similar approach may work on Mac and Windows, but this has only been tested on Linux
so far.

Expand All @@ -24,11 +27,7 @@ Install protobuf:

- Install protobuf with your package manager

Install Python packages

- pip install protobuf stringcase, or see the venv section below

## Using a custom python venv
## Optional Python venv

If you don't want to `pip install protobuf` globally, you can
symlink the python bin from a venv into `python` at the top of
Expand All @@ -38,6 +37,12 @@ the project folder:
$ ln -sf /path/to/venv/bin/python python
```

## Install Python packages

```
pip install protobuf stringcase
```

## Build

Two files need to be built:
Expand Down

0 comments on commit 2768c42

Please sign in to comment.