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 basic readme #382

Merged
merged 5 commits into from
Aug 8, 2023
Merged

Add basic readme #382

merged 5 commits into from
Aug 8, 2023

Conversation

robbevp
Copy link
Member

@robbevp robbevp commented Dec 15, 2020

Add basic readme.
Fix #302

Topics to cover

  • Info about app (quick first draft - same as in API)
  • Screenshots for a few views
  • Deployment guide
  • Info for local development
  • Info for questions/bugs
  • Known issues

@robbevp robbevp added the documentation Improvements or additions to documentation label Dec 15, 2020
@robbevp robbevp added this to the 1.0 milestone Dec 15, 2020
@robbevp robbevp self-assigned this Dec 15, 2020
@chvp chvp self-assigned this Jul 10, 2021
@chvp chvp force-pushed the docs/add-basic-readme branch from 4c0840d to 0941360 Compare July 10, 2021 15:33
@chvp chvp force-pushed the docs/add-basic-readme branch from abd2c3e to 1471553 Compare July 10, 2021 15:42
@chvp chvp removed their assignment Jul 10, 2021
@chvp
Copy link
Member

chvp commented Nov 6, 2021

@robbevp do you think you'll get around to adding screenshots soon? Once the currently open pull requests on all the projects are merged I'd like to do 1.0 releases on all the projects. I feel like the project is ready for the 1.0 label. (Or do you still see any glaring problems preventing a 1.0 release?)

I can look into it as well if you don't foresee having time to do this in the (semi-)near future.

@robbevp
Copy link
Member Author

robbevp commented Nov 6, 2021

@robbevp do you think you'll get around to adding screenshots soon? Once the currently open pull requests on all the projects are merged I'd like to do 1.0 releases on all the projects. I feel like the project is ready for the 1.0 label. (Or do you still see any glaring problems preventing a 1.0 release?)

I can look into it as well if you don't foresee having time to do this in the (semi-)near future.

I'm not sure if I will have time to setup an environment to make screenshots with good artist images/album images. I'm still doubting whether we should go for one or two small artists/labels (but ask permission before) or go for really big artists.

Regarding 1.0 - I can't think of anything that is still missing.
Since the runner per location have a breaking change that needs api, web and api-client-js to match, it would be good to do merge those and then release 1.0

@chvp
Copy link
Member

chvp commented Nov 6, 2021

Regarding 1.0 - I can't think of anything that is still missing. Since the runner per location have a breaking change that needs api, web and api-client-js to match, it would be good to do merge those and then release 1.0

Yes, I was definitely going to wait for those.

@chvp chvp removed this from the 1.0 milestone Jul 2, 2022
@chvp chvp marked this pull request as ready for review August 8, 2023 18:57
@chvp chvp merged commit 4775625 into main Aug 8, 2023
@chvp chvp deleted the docs/add-basic-readme branch August 8, 2023 18:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Write up a decent README
2 participants