-
-
Notifications
You must be signed in to change notification settings - Fork 197
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
Improve quickstart guide #1563
base: master
Are you sure you want to change the base?
Improve quickstart guide #1563
Conversation
Thanks for your contribution @stepperpig ! Ill review thourougly when I can :) |
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.
Nice work, a few changes needed and some precision asked.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1563 +/- ##
=======================================
Coverage 96.82% 96.82%
=======================================
Files 108 108
Lines 7643 7643
=======================================
Hits 7400 7400
Misses 243 243 ☔ View full report in Codecov by Sentry. |
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.
some changes required but good progress so far!
removed .DS_Store file
shortened README qs
30b6b88
to
81f595b
Compare
f3d --help | ||
man f3d # Linux only | ||
``` | ||
See the [Quickstart Guide](QUICKSTART.md) for more information about getting started with F3D. |
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.
Im not sure I prefer this version tbh. The info is the same, just hard to get.
How about keeping just the first command in ``` ?
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.
do you think we should keep the second command then?
also do you think we should expand the section slightly with 1-2 basic key bindings? or leave it more concise?
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.
I think we should keep a single command here.
Since we now have a quick start guide, lets keep this section super short, so id say no bindings here.
@stepperpig please resolve discussions that you adressed. |
Fixes issue #1259
Changes:
Potential Suggestions: