Skip to content
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

install.rst: remove broken links and improve formatting #8511

Merged
merged 1 commit into from
Jun 3, 2024
Merged

Conversation

anbj
Copy link
Contributor

@anbj anbj commented Jun 3, 2024

Minor improvements.

Why are building instructions in the wiki and not in the docs?

@anbj anbj requested a review from a team June 3, 2024 11:22
@seisman
Copy link
Member

seisman commented Jun 3, 2024

Building instructions are in https://github.com/GenericMappingTools/gmt/blob/master/BUILDING.md, not in the wiki.

@anbj
Copy link
Contributor Author

anbj commented Jun 3, 2024

Ah, and that document isn't referenced in the technical reference, right?

Does that mean that all references to the wiki (build related) should instead link to BUILDING.md?

@seisman
Copy link
Member

seisman commented Jun 3, 2024

Ah, and that document isn't referenced in the technical reference, right?

Yes

Does that mean that all references to the wiki (build related) should instead link to BUILDING.md?

Yes.

Originally, the installation instructions were in the INSTALL.md file in the root directory of the repository and were not included in the documentation, so the linking to BUILDING.md works. However, a few months ago (#7885), we decided to move the installation instructions to the docs but forgot to update the links to BUILDING.md.

@seisman seisman merged commit ccc94f6 into master Jun 3, 2024
1 check passed
@seisman seisman deleted the install branch June 3, 2024 13:44
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.

None yet

2 participants