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

docs: add NixOS installation instructions to README #45

Merged
merged 1 commit into from
Dec 21, 2024

Conversation

ob7
Copy link
Contributor

@ob7 ob7 commented Dec 11, 2024

Add NixOS package installation section under a new "Package Managers" category in the installation instructions. This reflects tenere's recent addition to nixpkgs (NixOS/nixpkgs/pull/363556)

Resolves #43

@ob7
Copy link
Contributor Author

ob7 commented Dec 11, 2024

hmm .. just realized crates is considered a "package manager" so perhaps I need a different title than one I used here ...
I'll change the section I added called "Package Managers" to "System Package Managers"

@ob7 ob7 force-pushed the tenere-nixos-support branch from 1f5083f to 17c0f71 Compare December 11, 2024 06:51
@ob7
Copy link
Contributor Author

ob7 commented Dec 11, 2024

or maybe we don't even need a section for system package managers if nixos is only one and other distros probably just use crates? I'll remove the part that adds a new section and just put nixos section directly beneath crates section.

@ob7 ob7 force-pushed the tenere-nixos-support branch 2 times, most recently from a397e34 to 8150d44 Compare December 11, 2024 06:56
@ob7 ob7 changed the title docs: add NixOS installation instructions to README (#43) docs: add NixOS installation instructions to README Dec 11, 2024
@pythops
Copy link
Owner

pythops commented Dec 11, 2024

Can it be installed like this ?

nix-env -iA nixpkgs.tenere

@ob7
Copy link
Contributor Author

ob7 commented Dec 11, 2024

Any of the Nix install methods should work, however its only available in master until I backport it to a stable release like 24.11, 24.05, etc.

So thinking about it, even though tenere is in nixpkgs now, maybe hold off merging this until it's in one of the main release branches so that most ppl using nixos/nixpkgs will actually see it show up for them. As of now one needs to clone the nixpkgs repo and install it using the master branch. It's not yet visible in any of the channels.

@ob7
Copy link
Contributor Author

ob7 commented Dec 12, 2024

@pythops The backport to nixpkgs release-24.11 should work out the box, but for backport to release-24.05 I need to downgrade the cargo.lock to version 3: NixOS/nixpkgs#364671 Any objections?

@pythops
Copy link
Owner

pythops commented Dec 12, 2024

You are the maintainer of the nixpackage 😄 You do what you think is right buddy :)

@ob7
Copy link
Contributor Author

ob7 commented Dec 12, 2024

I wanted to make sure you weren't aware of any issues running tenere using deps generated for cargo.lock v3. I'll assume not, I just like to be thorough

@pythops
Copy link
Owner

pythops commented Dec 12, 2024

not that I know no.

@ob7 ob7 force-pushed the tenere-nixos-support branch 3 times, most recently from 4bee05f to d7c0738 Compare December 16, 2024 19:10
@ob7
Copy link
Contributor Author

ob7 commented Dec 16, 2024

@pythops - tenere has been successfully backported to nixos release-24.11 (NixOS/nixpkgs#364564). It can now be installed via normal release channels, as well as via nix-env -iA nixpkgs.tenere on non-nixos systems running nixpkgs! I tested on debian.

I still have a PR opened for backport to release-24.05 (NixOS/nixpkgs#364671) for ppl running older version.

README.md Outdated
tenere
];
```
or ```nix-env -iA nixpkgs.tenere``` on Non-NixOS systems
Copy link
Owner

Choose a reason for hiding this comment

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

maybe you can have it in multiple lines, Something like

Or as following for Non-NixOs systems
\```
nix-env -iA nixpkgs.tenere
\```

Add NixOS package installation instructions. This reflects tenere's
recent addition to nixpkgs in release-24.11
@ob7 ob7 force-pushed the tenere-nixos-support branch from d7c0738 to 927571c Compare December 17, 2024 22:32
@ob7
Copy link
Contributor Author

ob7 commented Dec 17, 2024

Hows this?:

tenere/README.md

Lines 56 to 59 in 927571c

For non-NixOS systems, install directly with:
```nix
nix-env -iA nixpkgs.tenere
```

@ob7 ob7 requested a review from pythops December 19, 2024 17:36
@pythops
Copy link
Owner

pythops commented Dec 21, 2024

Thanks buddy for the PR and the work done to add support for nix 🙏

@pythops pythops merged commit a4abf70 into pythops:master Dec 21, 2024
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.

Add to NixOS / nixpkgs
2 participants