Update README.md

This commit is contained in:
PandaDEV 2024-07-30 13:14:10 +02:00 committed by GitHub
parent 4498a23271
commit 1b8f471606
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -1,13 +1,39 @@
<div align="center"> <div align="center">
<img width="150px" src="https://github.com/user-attachments/assets/33770922-e62e-49d7-a6ce-f82b2eec01b6"/> <img align="center" width="128px" src="src-tauri/icons/128x128@2x.png" />
<h1 align="center"><b>Qopy</b></h1>
<p align="center">
The fixed, simple and reliable clipboard manager for both Windows and Linux.
<br />
<br />
<b>Download for </b>
Windows (<a href="https://github.com/0PandaDEV/Qopy/releases/download/v0.1.0/Qopy_0.1.0_x64_en-US.msi">msi</a>)
·
Linux (<a href="https://github.com/0PandaDEV/Qopy/releases/download/v0.1.0/Qopy_0.1.0_amd64.AppImage">AppImage</a> |
<a href="https://github.com/0PandaDEV/Qopy/releases/download/v0.1.0/Qopy_0.1.0_amd64.deb">deb</a> |
<a href="https://github.com/0PandaDEV/Qopy/releases/download/v0.1.0/Qopy-0.1.0-1.x86_64.rpm">rpm</a>)
<br />
<br />
<sup>(Unstable Nightly releases can be found <a href="https://github.com/0PandaDEV/qopy/actions/workflows/build.yml">here</a>) </sup>
</p>
</div> </div>
# Qopy > \[!IMPORTANT]
>
> **Star this project**, You will receive all release notifications from GitHub without any delay \~ ⭐️
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. <details>
<summary><kbd>Star History</kbd></summary>
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=0pandadev/qopy&theme=dark&type=Date">
<img width="100%" src="https://api.star-history.com/svg?repos=0pandadev/qopy&type=Date">
</picture>
</details>
## 📋 What is Qopy
Qopy is a fixed clipboard manager designed as a simple alternative to the standard clipboard in Windows. It aims to provide a smoother, more reliable experience. Plus, it's compatible with Linux, so you can enjoy the same great features on both operating systems.
❌ 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. ❌ 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)
## 🚧 Roadmap ## 🚧 Roadmap
- [ ] Setup guide - [ ] Setup guide
@ -17,41 +43,56 @@ The fixed clipboard manager. The goal is simple be a alternative to the standart
- [ ] Code highlighting https://github.com/0PandaDEV/Qopy/issues/7 - [ ] Code highlighting https://github.com/0PandaDEV/Qopy/issues/7
- [ ] Streamshare integration https://github.com/0PandaDEV/Qopy/issues/4 - [ ] Streamshare integration https://github.com/0PandaDEV/Qopy/issues/4
## 🖼️ Preview <sup>If you have ideas for features to include, please write a feature request [here](https://github.com/0pandadev/Qopy/issues).</sup>
## 📦 Preview
<img width="800px" src="https://github.com/user-attachments/assets/18e1f9e3-414c-46e2-9c51-61c6e63a06d2"/> <img width="800px" src="https://github.com/user-attachments/assets/18e1f9e3-414c-46e2-9c51-61c6e63a06d2"/>
<img width="800px" src="https://github.com/user-attachments/assets/46ec4672-f156-4426-a2cb-3a40d00dbcd6"/> <img width="800px" src="https://github.com/user-attachments/assets/46ec4672-f156-4426-a2cb-3a40d00dbcd6"/>
## ❤️ Donations & Support ## ❤️ 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. Qopy is open-source and free to use. I appreciate donations to support ongoing development and improvements. Your contributions are voluntary and help me enhance the app for everyone.
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. <a href="https://buymeacoffee.com/pandadev_"><img src="https://img.shields.io/badge/Buy_Me_A_Coffee-FFDD00?style=for-the-badge&logo=buy-me-a-coffee&logoColor=black"/></a>
<a href="https://buymeacoffee.com/pandadev_"><img src="https://img.shields.io/badge/Buy_Me_A_Coffee-323842?style=for-the-badge&logo=buy-me-a-coffee&logoColor=white"/></a> More options available via the Sponsor ❤️ button above.
Find more options by clicking the Sponsor ❤️ button on the top of this page. ## ⌨️ Local development
## 🤝 Contributing You can use GitHub Codespaces for online development:
To start contributing to Qopy, you'll need to have Rust and pnpm installed. Then, follow these steps: [![][codespaces-shield]][codespaces-link]
1. Clone the project using `git clone https://github.com/0PandaDEV/Qopy.git` Or to get Qopy set up on your machine, you'll need to have Rust and pnpm installed. Then, follow these steps:
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). ```zsh
git clone https://github.com/0pandadev/Qopy.git
cd Qopy
pnpm i
pnpm dev
```
## 🛠️ Building for Production > \[!TIP]
>
> If you are interested in contributing code, feel free to check out our GitHub [Issues](https://github.com/0pandadev/Qopy/issues).
## 🔨 Building for production
To build for production simply execute:
```zsh ```zsh
pnpm build 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. > \[!NOTE]
>
You can find them in `src-tauri/target/release/bundle`. > 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 ## 📝 License
Qopy is licensed under the Creative Commons Attribution-Noncommercial-Share Alike. See the [LICENSE file](./LICENCE) for more information. Qopy is licensed under the Creative Commons Attribution-Noncommercial-Share Alike. See the [LICENSE file](./LICENCE) for more information.
[codespaces-link]: https://codespaces.new/0pandadev/Qopy
[codespaces-shield]: https://github.com/codespaces/badge.svg