diff --git a/README.md b/README.md index 5f5257f..34b2dbb 100644 --- a/README.md +++ b/README.md @@ -1 +1,49 @@ +
+ +
+ # Qopy + +The fixed clipboard manager. The goal is simple be a alternative to the standart clipboard manager of windows. But it also supports Linux so you can also enjoy Qopy there. + +❌ macOS will probably be not supported if you want something similar on macOS take a look at [Raycast](https://www.raycast.com/) and their clipboard history extension. +#### [⬇️ Download Qopy](https://github.com/0PandaDEV/Qopy/releases) + +## 🖼️ Preview + + + +## ❤️ Donations & Support + +Qopy is an open-source project, and I rely on the support of the community to continue developing and improving the app. Although Qopy is free to use, I welcome donations from those who have found it to be a valuable app and would like to contribute to its development. + +Please note that Qopy is and will always be free to use. Your donation is entirely voluntary and is not required to use the app. + + + +Find more options by clicking the Sponsor ❤️ button on the top of this page. + +## 🤝 Contributing + +To start contributing to Qopy, you'll need to have Rust and pnpm installed. Then, follow these steps: + +1. Clone the project using `git clone https://github.com/0PandaDEV/Qopy.git` +2. Change into the project directory: `cd Qopy` +3. Install dependencies: `pnpm i` +4. Run the development server: `pnpm dev` + +For a list of how you can help me checkout the [issues section](https://github.com/0PandaDEV/Qopy/issues). + +## 🛠️ Building for Production + +```zsh +pnpm build +``` + +Don't worry, it will fail at the end because it can not detect a Private key, but the installer files will be generated regardless of that. + +You can find them in `src-tauri/target/release/bundle`. + +## 📝 License + +Qopy is licensed under the Creative Commons Attribution-Noncommercial-Share Alike. See the [LICENSE file](./LICENCE) for more information.