That’s true, we should link more prominently to the documentation, the small project link in the right sidebar can be easily overlooked. Opened an issue for discussion:
1 Like
Another point for those improving fpm to consider: I tried
https://fpm.fortran-lang.org/en/tutorial/hello-fpm.html
which led me to first steps but the first step mentioned there assumed that fpm had already been downloaded and did not say how to do that. Surely downloading is the first step?
I think opinions differ on this one.
IMO a tutorial geared towards usage does not make sense to include install instructions.
If it was a tutorial for integrating fpm with your editor I would most likely agree with you. At any rate, I agree with @awvwgk and I think we should “aggressively” display/link the download instructions/binaries:
- near the top of the fpm web page via a button or card
- near the top of the README via a section
- at the top of the tutorial via a hyperlink
I agree with @harper that installation instructions for a tool should come before the instructions on how to use the tool. Specifically in this case, “Installing fpm” should be the first part of the Tutorial, not a How-To Guide, IMO.
2 Likes
Well, I find myself in the middle. I think the usage should not include the install procedure, but it should start off with “assuming you have successfully installed fpm(1) per the instructions found at …”. There are a dozen methods for installing fpm, and if you already have it installed and are at the point you are looking for usage information it is not useful. If you are just getting started and come upon the usage documentation first, it should just point you easily to where the “real first step” is
I do not like having to guess which icon or button to push nearly as much as a nice opening sentence.
5 Likes
That’s reasonable FYI for anyone interested
1 Like