hoborg/Obtainium-Emulation-Pack
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

chore: update developer documentation

Browse Source
This commit is contained in:
Richard Macias
2025-06-02 09:27:18 -05:00
parent a227c61b99
commit b61fecc9d1
2 changed files with 46 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@@ -135,27 +135,39 @@ You are welcome to make a PR with a contribution.
#### 1. Making changes to the pack #### 1. Making changes to the pack
You'll want to directly edit only things in either `./pages/` or `./src/`. Everything else should be designed to update ##### Adding / Removing Applications
through scripts. Including the README!
...why template out the README? Because that table is very cumbersome to update on every change. To add, update or remove an application, you need to:
1. make edits to `src/applications.json`.
1. run `make release` in the root directory
#### 2. Pre-Commit #### 2. Pre-Commit
Before you commit, make sure to run `make release`. Before you commit, make sure to run `make release`.
This will: This will:
- template the README - template the README and update the table
- update the minified json release file - update the minified json release file
### Development Tips After running `make release`, please check for the following:
- `obtainium-emulation-pack-latest.json` has been updated
- `README.md` has been updated.
- Does the README table generate a friendly application name? If not, see documentation for `nameOverride`
- Does the README table generate a friendly applicaation URL? If not, see documentation for `urlOverride`
- Is the application in beta? If so, please exclude it from the JSON using `meta.excludeFromExport`
### Developer Documentation
#### Meta field options #### Meta field options
My scripts will do specific actions if a `meta` field is present My scripts will do specific actions if specific application keys are present in the
`application.json`
| key | type | default | description | | key | type | default | description |
| ---------------- | ------ | ------- | ------------------------------------------------------------------------- | | --------------------- | ------ | ------- | ------------------------------------------------------------------------------------------------------------------------- |
| exludeFromExport | bool | false | Excludes the app from the release export json. | | meta.exludeFromExport | bool | false | Excludes the app from the release export json. |
| exludeFromTable | bool | false | Excludes the app from the README table. | | meta.exludeFromTable | bool | false | Excludes the app from the README table. |
| nameOverride | string | null | overwrite emulator name, useful if the default name is not human friendly | | meta.nameOverride | string | null | Overwrite emulator name, useful if the default name is not human friendly |
| meta.urlOverride | string | null | Overwrite the application preview link. If empty, the readme table will use the application scraper link as the homepage. |

34
pages/development.md
View File

@@ -6,27 +6,39 @@ You are welcome to make a PR with a contribution.
#### 1. Making changes to the pack #### 1. Making changes to the pack
You'll want to directly edit only things in either `./pages/` or `./src/`. Everything else should be designed to update ##### Adding / Removing Applications
through scripts. Including the README!
...why template out the README? Because that table is very cumbersome to update on every change. To add, update or remove an application, you need to:
1. make edits to `src/applications.json`.
1. run `make release` in the root directory
#### 2. Pre-Commit #### 2. Pre-Commit
Before you commit, make sure to run `make release`. Before you commit, make sure to run `make release`.
This will: This will:
- template the README - template the README and update the table
- update the minified json release file - update the minified json release file
### Development Tips After running `make release`, please check for the following:
- `obtainium-emulation-pack-latest.json` has been updated
- `README.md` has been updated.
- Does the README table generate a friendly application name? If not, see documentation for `nameOverride`
- Does the README table generate a friendly applicaation URL? If not, see documentation for `urlOverride`
- Is the application in beta? If so, please exclude it from the JSON using `meta.excludeFromExport`
### Developer Documentation
#### Meta field options #### Meta field options
My scripts will do specific actions if a `meta` field is present My scripts will do specific actions if specific application keys are present in the
`application.json`
| key | type | default | description | | key | type | default | description |
| ---------------- | ------ | ------- | ------------------------------------------------------------------------- | | --------------------- | ------ | ------- | ------------------------------------------------------------------------------------------------------------------------- |
| exludeFromExport | bool | false | Excludes the app from the release export json. | | meta.exludeFromExport | bool | false | Excludes the app from the release export json. |
| exludeFromTable | bool | false | Excludes the app from the README table. | | meta.exludeFromTable | bool | false | Excludes the app from the README table. |
| nameOverride | string | null | overwrite emulator name, useful if the default name is not human friendly | | meta.nameOverride | string | null | Overwrite emulator name, useful if the default name is not human friendly |
| meta.urlOverride | string | null | Overwrite the application preview link. If empty, the readme table will use the application scraper link as the homepage. |