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

Add a developer "getting started" page #15

Open
berry120 opened this issue Oct 2, 2021 · 2 comments
Open

Add a developer "getting started" page #15

berry120 opened this issue Oct 2, 2021 · 2 comments
Labels
enhancement New feature or request good first issue Good for newcomers hacktoberfest help wanted Extra attention is needed

Comments

@berry120
Copy link
Member

berry120 commented Oct 2, 2021

At present there's no "developer" documentation for cloning Quelea from Github, opening it in an IDE and running it for the first time. It would be good to have a page added that covers this type of "getting started" documentation from a developer perspective.

IntelliJ should be used as the example IDE where relevant, as that's by far the most popular Java IDE these days, and also the one the main developers use.

@berry120 berry120 added enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers hacktoberfest labels Oct 2, 2021
@rushikeshadhav
Copy link

rushikeshadhav commented Oct 7, 2021

I would like to contribute. Can you tell me what steps do I have to include in the documentation.

@joncojonathan
Copy link
Contributor

joncojonathan commented Oct 25, 2021

Note there are some starting steps at https://github.com/quelea-projection/Quelea/blob/master/docs/SETUP.md which may be a useful starting point.

I've submitted a PR to update those (quelea-projection/Quelea#508) as the instructions were out of date.

Longer term it's probably better to put a pointer in the main repo's SETUP.md to direct people to a developer section on the docs site.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers hacktoberfest help wanted Extra attention is needed
Development

No branches or pull requests

3 participants