Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add some instructions for testing changes with the simulator #194

Merged
merged 1 commit into from
Jun 11, 2022

Conversation

dae
Copy link
Contributor

@dae dae commented Jun 10, 2022

No description provided.

@mikehardy
Copy link
Member

Hmm - we have an effort called "doctor" here https://github.com/ankidroid/Anki-Android-Backend/blob/main/tools/doctor.sh

I think it would be easier than a bunch of installs and patches to make sure that was actually working (I think it is working? It was last time I went through) then this PR/doc should just boil down to 2 steps in the main README saying "run doctor" / alter this line in AnkiDroid/build.gradle ?

@dae
Copy link
Contributor Author

dae commented Jun 11, 2022

A few advantages of the approach described in this PR:

  • it doesn't require docker or building the docker images
  • it doesn't require installing cross
  • it doesn't require installing 3/4 of the architectures
  • it doesn't require building 3/4 architectures each time
  • it describes how the user can use a python venv instead of using a system-wide install
  • it describes how to install the appropriate ndk, instead of just telling you it's missing

Personally, when I am working on a project and discover a dependency has an issue, I want to know how I can make an experimental change to that dependency, and how I can most simply rebuild the parent project with the changes. I found the existing docs on this repo lacking here - the README only covers using the official release, and ENVIRONMENT spends most of the time talking about cross compilation and doesn't describe how to actually use the generated artifact.

@dae
Copy link
Contributor Author

dae commented Jun 11, 2022

(updated so unit tests work too)

@mikehardy
Copy link
Member

mikehardy commented Jun 11, 2022

Good feedback - I'd like the process to be as automated as possible, so I'd like doctor to work but even if doctor was working, without some effort to trim it's weight (all the arches and cross-compilation) this is still a valid optimization as the docker/cross stuff is pretty cumbersome. In the end I'm fine with incrementalism in practice and will merge this but organizationally I want to peel a few things out for tracking

@mikehardy mikehardy merged commit 427b990 into ankidroid:main Jun 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants