|
| 1 | +It is recommended that you build KNULLI via Docker instead of using a direct build. By using Docker, you significantly |
| 2 | +reduce the number of differences between your system and the system that developers are building on which reduces issues |
| 3 | +where the system builds fine for one person while failing for another. |
| 4 | + |
| 5 | +## System requirements |
| 6 | +- Linux Operating System capable of running docker |
| 7 | +- More than 100 GB of available disk space |
| 8 | + |
| 9 | +## Retro Achievements and Screen Scraper |
| 10 | +This build does not include the required keys for both Screen Scraper and RetroAchievements. The image will build |
| 11 | +succesfully without the key, but neither RetroAchievements or Screen Scraper will work without the keys. |
| 12 | + |
| 13 | +RetroAchievements and Screen Scraper will work if you add your own keys prior to building. |
| 14 | + |
| 15 | +## Step 1: Install Docker |
| 16 | + |
| 17 | +| Docker Version | Instructions | |
| 18 | +|-|-| |
| 19 | +| Docker Engine Only (Does not include Docker Desktop) |[https://docs.docker.com/engine/install/](https://docs.docker.com/engine/install/) | |
| 20 | +| Docker Desktop (Also includes Docker Engine) | [https://docs.docker.com/desktop/setup/install/linux/](https://docs.docker.com/desktop/setup/install/linux/) | |
| 21 | + |
| 22 | +## Step 2: Grab the latest source code |
| 23 | +``` |
| 24 | +$ git clone https://github.com/knulli-cfw/distribution distribution |
| 25 | +$ cd distribution |
| 26 | +$ git submodule init |
| 27 | +$ git submodule update |
| 28 | +``` |
| 29 | + |
| 30 | +## Step 3: Setup the docker container |
| 31 | +This is not required on every build. In fact, you can normally skip this step if you've done it already. |
| 32 | + |
| 33 | +You may need to remove your existing docker container and re-do this step if you are switching between different |
| 34 | +builds or if your are building the mainline and breaking changes have been made (e.g., a new app or library is |
| 35 | +required). |
| 36 | + |
| 37 | +``` |
| 38 | +$ make build-docker-image |
| 39 | +``` |
| 40 | + |
| 41 | +## Step 4: Building the target |
| 42 | + |
| 43 | +| Device | Build Target | |
| 44 | +|--------------------------|---------------------------| |
| 45 | +| Anbernic RG35XX Original | ``` ``` | |
| 46 | +| Anbernic RG35XX 2024 | ``` $ make h700-build ``` | |
| 47 | +| Anbernic RG35XX Plus | ``` $ make h700-build ``` | |
| 48 | +| Anbernic RG35XX SP | ``` $ make h700-build ``` | |
| 49 | +| Anbernic RG35XX-H | ``` $ make h700-build ``` | |
| 50 | +| Anbernic RG35XX-V | ``` $ make h700-build ``` | |
| 51 | +| Anbernic RG-CubeXX | ``` $ make h700-build ``` | |
| 52 | +| Trim UI Brick | ``` $ make a133-build ``` | |
| 53 | +| Trim UI Smart Pro | ``` $ make a133-build ``` | |
0 commit comments