-
Notifications
You must be signed in to change notification settings - Fork 1
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
Conversation
@@ -0,0 +1,4 @@ | |||
# README |
There was a problem hiding this comment.
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 | |||
|
There was a problem hiding this comment.
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`" |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
This needs work, see comments |
I will not. |
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. |
And they probably will, see this i mean |
Gotta have a README, bro