Xargon/MAME
1
0
Fork 0
mirror of https://github.com/RetroDECK/MAME.git synced 2024-11-21 12:25:39 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Enhanced readme explaining how to update the manifest

Browse source
This commit is contained in:
XargonWan 2024-06-26 22:39:18 +09:00
parent f424cf68b1
commit 4dbab2ee8e
1 changed files with 11 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
README.MD
View file

@ -1,6 +1,13 @@
## Updating Instruction
Do not edit 'net.retrodeck.mame.yml'
This file is automatically generated from 'mame-module.yml' and 'manifest-header.yml'
Any changes to 'net.retrodeck.mame.yml' will be discarded.
Please update 'mame-module.yml' and 'manifest-header.yml' instead.
Do not edit `net.retrodeck.mame.yml` nor `manifest-header.yml`:
These files are automatically generated by `automation_tools/update_mame_manifest.sh`.
`manifest-header.yml` is generated from the RetroDECK manifest itself, mind that:
- any changes to `net.retrodeck.mame.yml` will be discarded.
- any changes to `manifest-header.yml` will be discarded.
Then `manifest-header.yml` + the editable `mame-module.yml` are combined into `net.retrodeck.mame.yml`.
So please update `mame-module.yml` only.