Skip to content

docs: apply fork notice and credit to README_CRATES #5

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.

Sign up for GitHub

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

Merged
UnbreakableMJ merged 1 commit into from
Jun 16, 2026
Merged

docs: apply fork notice and credit to README_CRATES #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 24 additions & 10 deletions README_CRATES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@

**A modern, fast file copy tool for Linux with progress bars, resume capability, and more.**

[![Crates.io](https://img.shields.io/crates/v/copy.svg)](https://crates.io/crates/copy)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE-MIT)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)


[Features](#features) •
Expand All @@ -17,6 +16,9 @@

---

> [!NOTE]
> **Personal fork.** `copy` is a personal, modified fork of [**cpx**](https://github.com/11happy/cpx) by Bhuminjay Soni ([@11happy](https://github.com/11happy)) — rebranded from `cpx` to `copy` and adapted for my own use. It is **not** affiliated with or endorsed by the upstream project and is maintained on a best-effort basis. For the original, actively maintained tool, use [11happy/cpx](https://github.com/11happy/cpx).

## Why copy?

`copy` is a modern replacement for the traditional `cp` command, built with Rust for maximum performance and safety on Linux systems.
Expand All @@ -38,7 +40,7 @@ Copying 51% ██████████████████████
### Prerequisites

- **Linux** (kernel 4.5+ recommended for fast copy)
- **Rust** 1.70 or later
- **Rust** 1.85 or later (edition 2024)


### Quick Install (Recommended)
Expand All @@ -51,11 +53,6 @@ Or with wget:
wget -qO- https://raw.githubusercontent.com/UnbreakableMJ/copy/main/install.sh | bash
```

### From Crates.io
```bash
cargo install copy
```

### Arch Linux (AUR)
A first-party PKGBUILD lives in [`packaging/aur/`](packaging/aur/). Build and install it from a checkout:
```bash
Expand Down Expand Up @@ -90,7 +87,20 @@ copy --version

### Pre-built Binaries

Download from [Releases](https://github.com/UnbreakableMJ/copy/releases)
Prebuilt Linux binaries are attached to each [release](https://github.com/UnbreakableMJ/copy/releases). The current release is **v0.1.4**:

| Target | Asset |
|--------|-------|
| x86_64 (glibc) | `copy-linux-x86_64.tar.gz` |
| x86_64 (musl, static) | `copy-linux-x86_64-musl.tar.gz` |
| aarch64 | `copy-linux-aarch64.tar.gz` |
| armv7 | `copy-linux-armv7.tar.gz` |

```bash
# Example: x86_64 (glibc)
curl -fsSL https://github.com/UnbreakableMJ/copy/releases/download/v0.1.4/copy-linux-x86_64.tar.gz | tar xz
./copy --version
```

## Quick Start

Expand Down Expand Up @@ -262,8 +272,12 @@ cargo run -- -r test_data/ test_dest/

## License

- MIT [LICENSE](https://github.com/UnbreakableMJ/copy/blob/main/LICENSE)
MIT — see [LICENSE](LICENSE). Copyright © 2026 Bhuminjay Soni (original author of [cpx](https://github.com/11happy/cpx)); rename and fork modifications by [UnbreakableMJ](https://github.com/UnbreakableMJ), released under the same MIT license.


## Credits

`copy` is a fork of [**cpx**](https://github.com/11happy/cpx) by **Bhuminjay Soni** ([@11happy](https://github.com/11happy)). The original tool — its design and implementation — is entirely their work, reused here under the MIT license. This fork renames the binary to `copy`, flattens the CLI so copy is the root command, and adds Nix / AUR / Guix packaging; full credit for the underlying tool goes upstream.

## Acknowledgments

Expand Down