Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme update #1514

Open
wants to merge 72 commits into
base: master
Choose a base branch
from
Open
Changes from 1 commit
Commits
Show all changes
72 commits
Select commit Hold shift + click to select a range
2334970
WIP Update README.md
OctopusButtons Dec 31, 2024
c51a11f
Merge branch 'libretro:master' into master
OctopusButtons Jan 6, 2025
0a7a00a
WIP edits README.md
OctopusButtons Jan 6, 2025
fddac63
wip edits README.md
OctopusButtons Jan 6, 2025
5a8af9d
wip notes
OctopusButtons Jan 8, 2025
ad2201a
WIP Update README.md
OctopusButtons Jan 12, 2025
c453457
Update README.md
OctopusButtons Jan 12, 2025
78a06e7
WIP Update README.md
OctopusButtons Jan 13, 2025
2037602
WIP Update README.md
OctopusButtons Jan 13, 2025
fd0890e
WIP Update README.md
OctopusButtons Jan 13, 2025
23a7c55
WIP Update README.md
OctopusButtons Jan 13, 2025
5a2f931
WIP Update README.md
OctopusButtons Jan 13, 2025
723776b
WIP Update README.md
OctopusButtons Jan 14, 2025
31334f1
WIP README.md
OctopusButtons Jan 14, 2025
d369ec9
WIP Update README.md
OctopusButtons Jan 15, 2025
9b9bf7e
WIP Update README.md
OctopusButtons Jan 15, 2025
fd24c67
Update README.md
OctopusButtons Jan 15, 2025
704ca79
WIP Update README.md
OctopusButtons Jan 15, 2025
6c09473
Update README.md
OctopusButtons Jan 15, 2025
624b279
Update README.md
OctopusButtons Jan 15, 2025
ee71cbe
WIP Update README.md
OctopusButtons Jan 15, 2025
cb3c051
WIP Update README.md
OctopusButtons Jan 15, 2025
59554cd
WIP README.md
OctopusButtons Jan 16, 2025
01d9ca2
WIP Update README.md
OctopusButtons Jan 16, 2025
fb068c5
WIP Update README.md
OctopusButtons Jan 16, 2025
8ffb27b
WIP Update README.md
OctopusButtons Jan 16, 2025
4bdcb44
WIP Update README.md
OctopusButtons Jan 17, 2025
b521320
WIP Update README.md
OctopusButtons Jan 17, 2025
4efc669
WIP Update README.md
OctopusButtons Jan 17, 2025
35374bf
WIP Update README.md
OctopusButtons Jan 17, 2025
7ef2af7
WIP Update README.md
OctopusButtons Jan 18, 2025
e150f26
WIP Update README.md
OctopusButtons Jan 18, 2025
da8a02d
WIP Update README.md
OctopusButtons Jan 18, 2025
6f4c3a8
WIP Update README.md
OctopusButtons Jan 18, 2025
1d6492f
WIP Update README.md
OctopusButtons Jan 18, 2025
ccf5056
WIP Update README.md
OctopusButtons Jan 18, 2025
d4667d4
WIP Update README.md
OctopusButtons Jan 19, 2025
c92de50
Update README.md
OctopusButtons Jan 19, 2025
072cd3d
Update README.md
OctopusButtons Jan 19, 2025
ebbbac0
Update README.md
OctopusButtons Jan 19, 2025
e90b424
Update README.md
OctopusButtons Jan 19, 2025
26d22ea
Update README.md
OctopusButtons Jan 19, 2025
78b587c
Update README.md
OctopusButtons Jan 19, 2025
dcd248d
Update README.md
OctopusButtons Jan 19, 2025
98729b0
WIP Update README.md
OctopusButtons Jan 19, 2025
8b51d09
WIP Update README.md
OctopusButtons Jan 19, 2025
496542c
WIP Update README.md
OctopusButtons Jan 19, 2025
f8c30b1
WIP Update README.md
OctopusButtons Jan 20, 2025
14519cd
WIP Update README.md
OctopusButtons Jan 20, 2025
acd3057
Update README.md
OctopusButtons Jan 20, 2025
64e3d4a
Update README.md
OctopusButtons Jan 20, 2025
1bd9f08
Update README.md
OctopusButtons Jan 20, 2025
fe1e00c
Update README.md
OctopusButtons Jan 20, 2025
0f732ff
Update README.md
OctopusButtons Jan 20, 2025
65d7423
Update README.md
OctopusButtons Jan 20, 2025
2dcbeb7
Update README.md
OctopusButtons Jan 20, 2025
56a0016
Update README.md
OctopusButtons Jan 20, 2025
50d85e4
Update README.md
OctopusButtons Jan 20, 2025
6a6a768
Update README.md
OctopusButtons Jan 20, 2025
4cdbc0f
Update README.md
OctopusButtons Jan 20, 2025
ae08155
edit (reviewer point): fixed link
OctopusButtons Jan 22, 2025
369eb76
Fixed (reviewer point) heder `name` generalization
OctopusButtons Jan 22, 2025
5956557
Even better fixes on (reviewer point) `name` header
OctopusButtons Jan 22, 2025
1ee78db
Fixes from Review
OctopusButtons Feb 9, 2025
154e1d7
WIP review edits
OctopusButtons Feb 9, 2025
e496ac3
container header for Fields & Headers
OctopusButtons Feb 9, 2025
cbd5676
Renamed "Repository Contents" to Repository Folders
OctopusButtons Feb 9, 2025
f53aaa5
Update README.md
OctopusButtons Feb 9, 2025
eb8f87b
Bullet sub-head bold fix
OctopusButtons Feb 9, 2025
9592592
Re-organized into Contents > {File Types, Folder Guide}
OctopusButtons Feb 9, 2025
9c1a278
Shortened "Databases & Thumbnails" section
OctopusButtons Feb 9, 2025
dd3b32d
edits to shortened bit on Databases and Thumbnails
OctopusButtons Feb 9, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
WIP Update README.md
WIP
OctopusButtons authored Jan 16, 2025
commit fb068c56c7e183b8889a16099921b208c4a87bd0
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -185,8 +185,6 @@ Many source databases are in use as listed below. A large majority of games com

# Maintenance / Technical Usage
OctopusButtons marked this conversation as resolved.
Show resolved Hide resolved

Note that the [build script](https://github.com/libretro/libretro-super/blob/master/libretro-build-database.sh) specifies exact `.dat` files and folders in the repository, therefore organizational revisions to the file/folder structure should have corresponding planning in the build script.

## Building

To build a complete set of RDB files for RetroArch or to generate a single RDB file, see [RetroArch/libretro-db/README.md](https://github.com/libretro/RetroArch/blob/master/libretro-db/README.md).
@@ -205,6 +203,9 @@ Make sure filenames are Windows file system compatible, and are not too long (eg
find -exec basename '{}' ';' | egrep '^.{144,}$'
```

Note that the [build script](https://github.com/libretro/libretro-super/blob/master/libretro-build-database.sh) specifies exact `.dat` files and folders in the repository, therefore organizational revisions to the file/folder structure should have corresponding revisions in the build script.


# Contributions
OctopusButtons marked this conversation as resolved.
Show resolved Hide resolved

A vast majority of the database's game information originates from routine imports from upstream data groups (No-Intro, Redump, TOSEC, GameTDB, etc). General best practice for corrections or additions is for a contributor to go through the systems and channels of the relevant groups, because a change in Libretro's copy of their database would be overwritten and lost with the next import from upstream.. Changes that they incorporate in their databases will eventually cycle through to the Libretro databases.