From 1b8f4716064fa20e7467310830a6e1c4cf2ef798 Mon Sep 17 00:00:00 2001 From: PandaDEV <70103896+0PandaDEV@users.noreply.github.com> Date: Tue, 30 Jul 2024 13:14:10 +0200 Subject: [PATCH] Update README.md --- README.md | 81 +++++++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 61 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index f54d41d..623099e 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,39 @@
- + +

Qopy

+

+ The fixed, simple and reliable clipboard manager for both Windows and Linux. +
+
+ Download for + Windows (msi) + · + Linux (AppImage | + deb | + rpm) +
+
+ (Unstable Nightly releases can be found here) +

-# 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. +
+ Star History + + + + +
+ +## 📋 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. -#### [⬇️ Download Qopy](https://github.com/0PandaDEV/Qopy/releases) ## 🚧 Roadmap - [ ] 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 - [ ] Streamshare integration https://github.com/0PandaDEV/Qopy/issues/4 -## 🖼️ Preview +If you have ideas for features to include, please write a feature request [here](https://github.com/0pandadev/Qopy/issues). + +## 📦 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. +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. + - +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` -2. Change into the project directory: `cd Qopy` -3. Install dependencies: `pnpm i` -4. Run the development server: `pnpm dev` +Or to get Qopy set up on your machine, you'll need to have Rust and pnpm installed. Then, follow these steps: -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 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`. +> \[!NOTE] +> +> 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. + +[codespaces-link]: https://codespaces.new/0pandadev/Qopy +[codespaces-shield]: https://github.com/codespaces/badge.svg