-
Notifications
You must be signed in to change notification settings - Fork 111
docs: simplify & update README #778
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
Conversation
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.
If you remove some install instructions but keep others, then the ones you keep implicitly become the recommended ones. Do we really recommend Conda as the best way to get fpm? That requires having and using yet another tool. I think it's okay to keep the Conda and Homebrew instructions, but at the very least also keep and recommend the link to the binary release downloads, as that's the easiest way to get fpm without assuming a 3rd party package manager.
Other changes look good!
@milancurcic Thanks for the quick turnaround in this PR. I agree I was actually meant to include them first but I somehow forgot. I think we might need to do some edits on the fpm-docs repo as well. Specifically, I would suggest:
|
- Added multiple links to the FPM webpage, homepage, downloading instructions and Getting started and tutorials - Removed most of the install instructions and redirected to website - Removed bootstrapping instructions - Added fpm logo with hyperlink in README - Fixed link to Manifest in README Fixes Link to documentation in README #776
48f062e
to
df34943
Compare
Please CC anyone else that should review this. Remember to check accompanying PR fortran-lang/fpm-docs#87 |
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 it's good to go, thanks!
|
||
#### Bootstrapping on other platforms | ||
**Follow our [Quickstart Tutorial](https://fpm.fortran-lang.org/en/tutorial/hello-fpm.html) to get familiar with fpm**. |
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.
Does this need to be bold?
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.
No, just personal taste to point the user to the next step. I can remove it if you want.
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.
Thanks @gnikit, this is a really nice improvement!
This PR proposes a new simpler README for fpm, which redirects a lot of the reading to the fpm website.
Linked to fpm-docs PR: fortran-lang/fpm-docs#87
Move bootstrapping to contributingno needMention the Environmental variables in fpm-docswrite a tutorialFixes Link to documentation in README #776