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

Using gmt in NixOS #8506

Merged
merged 1 commit into from
Jun 1, 2024
Merged

Using gmt in NixOS #8506

merged 1 commit into from
Jun 1, 2024

Conversation

miniBill
Copy link
Contributor

@miniBill miniBill commented Jun 1, 2024

Adding NixOS instructions

Copy link

welcome bot commented Jun 1, 2024

💖 Thanks for opening this pull request! 💖

Please make sure you read our Contributing Guide and abide by our Code of Conduct.

A few things to keep in mind:

  • If you need help writing tests, take a look at the existing ones for inspiration. If you don't know where to start, let us know and we'll walk you through it.
  • All new features should be documented. It helps to write the comments below for your functions describing the it, all arguments, and return types before writing the code. This will help you think about your code design and results in better code.
  • We are grateful that you put in the effort to do this! 🎉

NixOS
~~~~~

Use GMT in your shell via:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess you mean "Install GMT ..."?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, I intentionally wrote it that way.

nix shell nixpkgs#packagename will start a shell where packagename is available without the need to permanently install it on your system (when you close the shell, the package is not used/active anymore and is going to be eventually garbage collected).

To install it you would either add it to your system configuration or your home-manager configuration. Instructions on how to do that are probably unneeded for most NixOS users, the important part is the list of packages.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can also install the packages via nix-env -iA, but that's nondeclarative and honestly better not used at all in favor of a fully declarative approach.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, that sounds wasteful but I know nothing about NixOS (other than the name). But this is a section about how to install GMT. Wouldn't it be appropriate to add that info on NixOS installation as well?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The installation instructions would be "add gmt, gshhg-gmt and dcw-gmt to your list of packages". I can add that, I guess.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, please. And explain also that difference between using and installing. NixOS users may know that but others likely do not.

Copy link
Contributor Author

@miniBill miniBill Jun 1, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done [as in, switch to installation instructions, I hadn't read your last message, sorry]

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I mean, You can leave both informations. Using and Installing if you find it appropriate.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nah, this is fine

@joa-quim joa-quim merged commit 9454b08 into GenericMappingTools:master Jun 1, 2024
1 check passed
Copy link

welcome bot commented Jun 1, 2024

🎉🎉🎉 Congrats on merging your first pull request and welcome to the team! 🎉🎉🎉

We hope that this was a good experience for you. Let us know if there is any way that the contributing process could be improved.

@miniBill miniBill deleted the patch-1 branch June 5, 2024 17:01
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.

2 participants