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.

Sign up for GitHub

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

Update readme #533

Merged
merged 4 commits into from
Dec 20, 2024
Merged

Update readme #533

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7d24aaa
simplify build instructions, add disclaimer
pazos Dec 11, 2024
3ebb0a8
remove TODO list that we won't plan to do
pazos Dec 11, 2024
310d1a6
Update README.md
pazos Dec 11, 2024
e1ca1d1
Update README.md
pazos Dec 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 0 additions & 8 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,14 +74,6 @@ build-luajit:
cd jni/luajit && \
./mk-luajit.sh "$(ANDROID_FULL_ARCH)"

prepare: update
@echo "Building LuaJIT for all supported ABIs"
cd jni/luajit && \
./mk-luajit.sh clean && \
./mk-luajit.sh x86 && \
./mk-luajit.sh clean && \
./mk-luajit.sh armeabi-v7a

debug: update build-luajit-debug
@echo "Building $(APPNAME) debug APK: Version $(NAME), release $(VERSION), flavor $(FLAVOR)"
./gradlew -q -PversName=$(NAME) -PversCode=$(VERSION) -PprojectName=$(APPNAME) \
Expand Down
37 changes: 15 additions & 22 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,40 +19,33 @@ Have a look at KOReader's [llapp_main.lua](https://github.com/koreader/koreader/

The real starting point, called from JNI/C, is the run() function in android.lua. It sets up a few things, namely FFI definitions for the Android native API (since it uses that itself for a few things) and some wrapper functions for logging. Also, it registers the "android" module in package.loaded, so you can access it in your own code via require("android"). It also registers a new package loader which can load Lua code from the activity's asset store, so you can use require() for Lua code stored there.

## Starting
## Disclaimer

### Init and update the submodules
This repo is used as glue code to run KOReader on android.

```sh
make update
```

### Compile LuaJIT for all target architecture(s)
Usage on its own doesn't make much sense since you're expected to write your own drawing routines in lua!
A standalone example is attached (with no drawing routines!) in case you're curious what you'll get.

```sh
make prepare
```

## Building the example app

### Compile native code and package APK with gradle

You can see available tasks with
### Export `ANDROID_NDK_HOME`

```sh
./gradlew tasks
export ANDROID_NDK_HOME=/path/to/your/ndk/folder
```

For example, you can build the debug variant for all supported ABIs with
### Build example APK for arm 32 bits

```sh
./gradlew assembleDebug
make example
```

For more examples please look at the Makefile.

## To-do
### Build example APK for any other arch

```sh
ANDROID_ARCH=MY_ARCH make example
```

* a concept to deal with native Lua modules.
* a loader for native modules that have been put into the activity's library directory?
* a loader for obb storage, maybe? We could put native Lua modules there, for example.
* example code for framebuffer access and more
where `MY_ARCH` is either `x86`, `x86_64` or `arm64`
Loading