Skip to content

Commit 9d6cd3d

Browse files
committed
Added library versions into readme.md
1 parent 3311e6e commit 9d6cd3d

File tree

2 files changed

+21
-3
lines changed

2 files changed

+21
-3
lines changed

README.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
1. [SDK and NDK installation](#sdk-and-ndk-installation)
66
2. [Building the app](#building-the-app)
77
2. [Installing the app](#installing-the-app)
8+
3. [3rd party applications](#3rd-party-applications)
89

910

1011

@@ -19,7 +20,7 @@ The SDK and NDK can be installed either at the initial (one-time) setup for Andr
1920

2021
After pressing `apply`, an installer should appear. Once everything is finished, you can leave the settings.
2122

22-
Note that SDK `34.0.0` and NDK `25.1.8937393` were used during the development.
23+
Note that SDK `34.0.0` and NDK `25.1.8937393` were used during the development (see [3rd party applications](#3rd-party-applications) for more detailed info)
2324

2425
### Building the app
2526
The app can be built via [AndroidStudio](https://developer.android.com/studio) or by running
@@ -40,4 +41,22 @@ If you connect your phone to [AndroidStudio](https://developer.android.com/studi
4041
```bash
4142
adb install -r ./app/build/outputs/apk/debug/app-debug.apk
4243
```
43-
from the `simulation` folder to install the `apk`.
44+
from the `simulation` folder to install the `apk`.
45+
46+
47+
## 3rd Party Applications
48+
The following list of 3rd party applications was used in this project:
49+
- [GLM](https://github.com/g-truc/glm) 1.0.1
50+
- [zlib](https://github.com/madler/zlib) 1.3.1
51+
- [hdf5](https://github.com/HDFGroup/hdf5) 1.14.4.2
52+
- [netcdf-c](https://github.com/Unidata/netcdf-c) 4.9.2
53+
- [netcdf-cxx](https://github.com/Unidata/netcdf-cxx4) 4.3.1
54+
55+
The libraries above have already been compiled for Android into shader objects (.so) and included in the project. Thus, there is no need to recompile them. However, follow the `simulation/third_party/` instructions if you need to recompile them anyway.
56+
57+
For compiling and building the project for Android, the following list of tools was used:
58+
- [NDK](https://developer.android.com/ndk) 25.1.8937393
59+
- [Android SDK Build-Tools](https://developer.android.com/tools/releases/build-tools) 34.0.0
60+
- [Android SDK Platform-Tools](https://developer.android.com/tools/releases/platform-tools) 35.0.1
61+
- [CMake](https://cmake.org/) 3.22.1
62+
- [Gradle](https://gradle.org/) 8.4

simulation/TODO.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,6 @@ Note that the dense grid is pretty much an issue just for the compute shaders, f
4545
- Mention the different (attempted) different ways of rendering stuff - so far: LIC
4646
- Make a measurement for the "new bottleneck" see how the performance changes with a more random distrib. (either perlin, or bigger double-gyre)
4747

48-
- Put detailed lib versions in the readme.md
4948
- Put library credit in the readme.md
5049
- Add apk as a github release
5150

0 commit comments

Comments
 (0)