update README.md

merge-requests/1/head
James Miller 2019-08-02 17:56:21 -05:00
parent f294c5590b
commit cc5bfb15d2
1 changed files with 26 additions and 1 deletions

View File

@ -1,3 +1,28 @@
# Pathfinder 2 Sqlite # Pathfinder 2 Sqlite
This will be a repository for the code necessary to generate a sqlite database containing the open gaming content for the Pathfinder 2 table-top role-playing-game system that is available under the Open Gaming License. Pull requests welcomed! This will be a repository for the code necessary to generate a sqlite database
containing the open gaming content for the Pathfinder 2 table-top
role-playing-game system that is available under the Open Gaming License. Pull
requests welcomed!
## Why sqlite?
It's an open, permissively licensed, and portable single-file database that does
not require setting up a client/server model. It's also likely that the database
will fit into memory easily so performance issues aren't likely to be a problem.
Also, most use cases of this data will likely be read only, so the sqlite
limitations on concurrent writes won't be an issue either.
## Why not JSON?
Because I'd rather leverage sql's power, than writing internal code to a future
Pathfinder 2 app. Also, because sqlite is pretty much language agnostic at this
point; Pythonistas, Gophers, Rustaceans, and anything in between can access a
sqlite database.
## Roadmap
1. Design schema;
2. Write script to generated sqlite database from sql code;
3. Write sql code; and
4. Drinks for all when finished!