BaltimoreCity / BaltimoreTechWebsite

1 stars 1 forks source link

More robust README #25

Closed deld closed 5 years ago

deld commented 5 years ago

Please update the readme to be more verbose

For example 1) Give people our workflow, fork the repo, make a feature branch, make the change, add a commit message and issue a pull request to get it merged into the base 2) Add more details to where to make changes, adding very detailed descriptions before each data section, then an example. For example, if for Organizations, you may say in the X directory add an image with a resolution and size of AxB with a file name of __.

Also a history section on top of the README, which will talk about the origin of the portal. This can be a placeholder for now, I'll fill it out with more details later.