antus wrote:i'd suggest not touching the files. adding info at the end would be better than the start but it'll be a lot harder to work with for people who dont understand whats going on. github is for code, but it can do what we need. you'll need to look in to how you clone the repo, create a branch on your machine, switch to that branch, edit it how you like then send a pull request back to the archive owner. they should then accept it, and your changes are in the main repo for others.
I was thinking more of a different file type. Drop the .bin data entirely into say a json structure. The json itself could house the metadata and the bin and the bin code itself is just a section of the json. I agree, you would NOT want to modify the internal structure of the BIN itself. Unfortunately it is a chicken and egg situation that is unlikely to get developed.
I am learning GitHub as we speak. Unfortunately I do wish it had bit more database type structure but that is not the intent of GitHub. We are actually looking for more document management then anything else, but that is not as popular and I'm not finding any well known document management sources available for free. Something like an Confluence/Jira/Bitbucket instance would be great, but I doubt anyone wants to pay for that...
antus wrote:I would suggest we keep file details in the readme file in each directory. When viewing github you'll see the details of what is what down the bottom. Some kind of tables in the markup that github uses should be able to do this nicely. if we got really in to it we could write and app or a script that can load the readme, pull a bunch of additional info out the bins and fill out fields in the readme. I could see filename, service number, hardware number, osid, year, pcm type, engine, transmission, stock?, description being populated manually, and a script adding the ids of each segment if we wanted to go that far. we could have factory cvn too. It just depends if anyone is willing to put in the time to start it, or even better but perhaps asking too much, do the whole archive?
This is my hope. I'm hesitant to dive too far into structuring right now since I'm not well versed with GitHub services but I think this is how it will end up. Each Bin or XDF will get its own "folder" and inside the folder the .md can hold the details. Not very pretty but it should help. The downside I'm seeing right now is structure. I want to flatten the structure as much as possible and use metadata or tagging to help organize, but Github isn't a database in this manner so you can't sort info all too well. I also can't create relationships between hardware specifications which is something I really want to do. Diving into bins and specs gets even more messy if you don't know if the hardware supports DBC, TAC, etc and so it would be great to start a repository for the hardware specs that could be tied together, but that is a database not Github...