Skip to content

Update README.md #414

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md #414

wants to merge 1 commit into from

Conversation

eapo
Copy link

@eapo eapo commented Mar 12, 2025

  1. Separate installation scripts
  2. Add NixOS shell.nix method

Alternatively using shell.nix (NixOS)

{ pkgs ? import <nixpkgs> { } }:

pkgs.mkShell {
  buildInputs = [
  ];
 
  shellHook =
    ''
      npx repomix --ignore "data/,ai-docs/,myenv/,.vscode/"
    '';
}

Add NixOS shell.nix method
@eapo eapo requested a review from yamadashy as a code owner March 12, 2025 22:54
@yamadashy
Copy link
Owner

Hi, @eapo !
Thank you for your PR! I appreciate you adding installation instructions for NixOS users.

I think this is a valuable addition, but I'd like to suggest a small change to the placement. Since the shell.nix approach isn't strictly a "global installation" but rather a project-specific environment setup, it might be confusing to include it in the "Install globally for repeated use" section.

Would it be possible to create a new section titled "Using with NixOS" and place it before the "Alternative Tools 🛠️" section? This would make the README structure clearer and help users find the installation method appropriate for their environment.

A structure like this would work well:

## Using the CLI Tool `>_`

### Install globally for repeated use:
...

### Using with NixOS
For NixOS users, you can create a `shell.nix` file in your project:
...

## Alternative Tools 🛠️
...

What do you think about this organization? It clearly separates the global installation section from the NixOS usage method.

Thanks again for contributing to make Repomix more accessible to NixOS users!

Copy link

codecov bot commented Mar 15, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.28%. Comparing base (944b1c2) to head (4e60e3d).
Report is 57 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #414   +/-   ##
=======================================
  Coverage   84.28%   84.28%           
=======================================
  Files          77       77           
  Lines        3748     3748           
  Branches      756      756           
=======================================
  Hits         3159     3159           
  Misses        589      589           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

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