Skip to content

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

Merged
merged 3 commits into from
Oct 29, 2022
Merged

docs: simplify & update README #778

merged 3 commits into from
Oct 29, 2022

Conversation

gnikit
Copy link
Member

@gnikit gnikit commented Oct 12, 2022

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

  • 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
  • Move bootstrapping to contributing no need
  • Mention the Environmental variables in fpm-docs write a tutorial

Fixes Link to documentation in README #776

@gnikit gnikit requested review from awvwgk and milancurcic October 12, 2022 16:13
@gnikit gnikit marked this pull request as draft October 12, 2022 16:14
Copy link
Member

@milancurcic milancurcic left a 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!

@gnikit
Copy link
Member Author

gnikit commented Oct 12, 2022

@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:

  • moving "Installing fpm" (https://fpm.fortran-lang.org/en/how-to/installation.html) at the very top the TOC on the left and outside "How To"
  • Remove the "Design Documents" card from the homepage and add an "Install fpm" card. The order of the cards being from left to right, top to bottom (1. "Install fpm", 2. "Tutorials", 3. "How-To Guides" (now empty), 4. "References")

- 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
@gnikit gnikit marked this pull request as ready for review October 27, 2022 13:59
@gnikit gnikit requested a review from milancurcic October 27, 2022 13:59
@gnikit
Copy link
Member Author

gnikit commented Oct 27, 2022

Please CC anyone else that should review this. Remember to check accompanying PR fortran-lang/fpm-docs#87

Copy link
Member

@milancurcic milancurcic left a 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**.
Copy link
Member

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?

Copy link
Member Author

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.

Copy link
Member

@LKedward LKedward left a 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!

@LKedward LKedward merged commit 77cc356 into main Oct 29, 2022
@LKedward LKedward deleted the gnikit/issue776 branch October 29, 2022 09: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.

3 participants