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 README and LICENSE #48

Merged
merged 5 commits into from
Jun 30, 2024
Merged

add README and LICENSE #48

merged 5 commits into from
Jun 30, 2024

Conversation

marcoow
Copy link
Member

@marcoow marcoow commented Apr 26, 2024

see #20

@marcoow marcoow requested a review from LukeMathWalker April 26, 2024 13:38
@marcoow
Copy link
Member Author

marcoow commented Apr 26, 2024

@BobrImperator let me know if you have any feedback as well – mainly interested in whether anything substantial is missing that should be in a README. There will be guides going into much more depth anyway.

@marcoow marcoow mentioned this pull request Apr 26, 2024
22 tasks
Copy link
Collaborator

@BobrImperator BobrImperator left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ideas:

  • pace without arguments should output --help by default
  • It'd be awesome to include the commands and their explanation in generated project's README. Currently it only has a project's name.
  • I think that the blueprint is missing a common place for starting other server dependencies. If I needed to create a background task, I'm forced to repeat the setup in both tests and the actual server.

Questions:

  • Would it be OK to add the cli/ crate to .gitignore?
    It causes quite a bit of bloat when searching up files.
    Alternatively, we could probably communicate that this is something the users won't have to touch anymore and they're free to exclude it themselves.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
@marcoow
Copy link
Member Author

marcoow commented Apr 29, 2024

It'd be awesome to include the commands and their explanation in generated project's README. Currently it only has a project's name.

Yes, that's to be done still

I think that the blueprint is missing a common place for starting other server dependencies. If I needed to create a background task, I'm forced to repeat the setup in both tests and the actual server.

I think that's something for a later release. There's quite some questions coming with that, e.g. what do you use as a persistent queue for a background tasks implementation.

Would it be OK to add the cli/ crate to .gitignore?

No since we want that to be checked in with the project. I understand you want to exclude it from your editor but I don't think adding it to .gitignore is the right way to achieve that.

@marcoow marcoow merged commit 16c5063 into main Jun 30, 2024
19 checks passed
@marcoow marcoow deleted the main-readme branch June 30, 2024 09:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants