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 missing README #1

Merged
merged 1 commit into from
Dec 2, 2024
Merged

Conversation

heavyimage
Copy link
Contributor

Gotta have a README, bro

@@ -0,0 +1,4 @@
# README
Copy link
Owner

Choose a reason for hiding this comment

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

Add a more descriptive title please

@@ -0,0 +1,4 @@
# README

Copy link
Owner

Choose a reason for hiding this comment

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

The license and a brief description of the project would usually go here.

It doesn't need to be that long, three to four hundred words is probably enough.

# README

## Running the code
"just do `cargo run --release`"
Copy link
Owner

Choose a reason for hiding this comment

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

It wouldn't hurt to outline the reasons for the --release flag

Copy link
Contributor Author

Choose a reason for hiding this comment

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

this is a direct copy/paste from your message to me so if anyone is to blame here, it's you.

@arcadeperfect
Copy link
Owner

This needs work, see comments

@heavyimage
Copy link
Contributor Author

I will not.

@heavyimage
Copy link
Contributor Author

I hope future employers won't see this and think I'm some kind of horrid code jerk instead of a good friend trying to help a buddy out in a non-passive aggressive and delightful way.

@arcadeperfect
Copy link
Owner

And they probably will, see this i mean

@arcadeperfect arcadeperfect merged commit d1fbf1a into arcadeperfect:main Dec 2, 2024
@heavyimage heavyimage deleted the add_readme branch December 2, 2024 20:29
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.

2 participants