Skip to content

Commit 99ee9f9

Browse files
committed
Add a readme
Signed-off-by: Joseph Mattiello <[email protected]>
1 parent 1128590 commit 99ee9f9

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Provenance Data
2+
3+
_repo to hold test roms, screenshot and index generation scripts_
4+
5+
## How to help
6+
7+
### Add ROMs
8+
9+
- Find a legal!, open-source homebrew or open domain rom
10+
- Rename ambigous extensions, fix spacing and formatting, ie; for Genesis, `my_demo_rom.bin` to `My Demo Rom.gen`
11+
- Zip it in a flat file with no other unrelated files, with the same filename as the game; ie; `My Demo ROM.zip`
12+
- Optionally, but preffered, add artwork. See "Add Artwork"
13+
14+
### Add artwork
15+
16+
- clone this repo
17+
- add artwork in the format (ROMNAME)-screenshot.png/jpg/jpeg or (ROMNAME)-cover.png/jpg/jpeg
18+
- run the generation script
19+
```sh
20+
python scan_roms.py
21+
```
22+
-- commit, push, make a pull-request

0 commit comments

Comments
 (0)