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.

Sign up for GitHub

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

Jump to bottom

Developer set-up instructions document -- developer_set-up.md #408

Open

2handsD wants to merge 5 commits into pinballmap:master from 2handsD:master

2handsD commented Dec 9, 2021

Submitting a markdown doc to provide instructions to potential contributors for getting the app up and running for development purposes.

2handsD added 5 commits

October 25, 2021 22:42


          first pass at local development documentation

a8072bf


          Update developer_set-up.md

69ceaa8

Use GitHub Flavored Markdown.


          Update developer_set-up.md

4cd43a5


          Update developer_set-up.md

656c03d


          Update developer_set-up.md

9d51202

Collaborator

RyanTG commented Dec 9, 2021

Thanks!! This looks great and is much appreciated.

I have two suggestions:

Name the file something simpler. Maybe instructions.md (or setup.md ?)
Link to the file in the readme. I'm thinking after the ..."if you have a website issue, please use that one!" in the readme, we could have a paragraph break, and then "If you want to contribute to the development of the Pinball Map app, start by following the installation instructions here." (or setup instructions ?)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet