Skip to content

Latest commit

 

History

History
269 lines (189 loc) · 9.76 KB

README.md

File metadata and controls

269 lines (189 loc) · 9.76 KB

Forks Stargazers Issues MIT License


Logo

Clipbird

A Bird that syncs Your clipboard data between devices connected in a local network.
Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Roadmap
  4. Contributing
  5. License
  6. Contact
  7. Acknowledgments
  8. Bonjour Integration
  9. Contributors
  10. Screenshots

About The Project

Clipbird Software helps you to sync your clipboard data between devices connected to a local network. It is a cross-platform software that works on various platforms. It is free and open-source software that is licensed under the MIT License. It currently supports Windows and Android.

(back to top)

Built With

  • Bonjour
  • C++
  • Qt6
  • OpenSSL

(back to top)

Getting Started

To Install Clipbird on your system, you can either download the installer from the release or build it from the source. The following steps will guide you through the installation process.

Installing Clipbird

Just go to Github Release choose the suitable version for your system and download it. Then install it in your system.

For Android, you can download it from clipbirdroid

Building Clipbird on a Windows

In the following steps, we will see how to build the project in the Windows platform, We use choco to install the dependencies. If you don't have choco installed in your system, you can install it from here.

Prerequisites

  • Bonjour
  • C++
  • Qt6
  • OpenSSL

Installing OpenSSL

Install OpenSSL using the following command and set the environment variable OPENSSL_ROOT_DIR to the OpenSSL installation directory.

choco install openssl

Installing Qt6

Go to Qt and download the Qt installer for Windows, then install it in your system. After installing Qt, you need to set the environment variable QT_CMAKE_DIR to the Qt cmake directory.

Installing Bonjour

Just go to Bonjour and download the Bonjour SDK for Windows, then install it in your system. It should set the environment variable BONJOUR_SDK_HOME to the Bonjour SDK directory.

Environment Variables

Variable Value
OPENSSL_ROOT_DIR OpenSSL installation directory
QT_CMAKE_DIR Qt6 cmake directory
BONJOUR_SDK_HOME Bonjour SDK directory

(back to top)

Building Clipbird on a Linux

Limitations on wayland,

  • The Clipboard auto sync feature will not work.
  • The Position of the window cannot be set.

Prerequisites

  • Avahi
  • C++
  • Qt6
  • libnotify
  • OpenSSL

Installing OpenSSL

Install OpenSSL using the following command.

sudo apt-get install libssl-dev

Installing Qt6

Go to Qt and download the Qt installer for Linux, then install it in your system. After installing Qt, you need to set the environment variable QT_CMAKE_DIR to the Qt cmake directory.

Installing Avahi

Install Avahi using the following command.

sudo apt-get install libavahi-compat-libdnssd-dev

Installing libnotify

Install libnotify using the following command.

sudo apt-get install libglib2.0-dev
sudo apt-get install libnotify-dev

Environment Variables

Variable Value
QT_CMAKE_DIR Qt6 cmake directory

Roadmap

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information. However, please note that it uses the Qt framework, which is licensed under the LGPL v3 and GPL v3 licenses.

(back to top)

Contact

Sri Lakshmi Kanthan P - @itsmekanth - [email protected]

Project Link: https://github.com/srilakshmikanthanp/clipbirdesk

(back to top)

Acknowledgments

Bonjour Integration

Bonjour

This project utilizes Bonjour technology by Apple for Advertising and Discovery of the devices that has Clipbird installed in the local network. Bonjour, also known as zero-configuration networking, enables automatic discovery of devices and services on a local network using industry standard IP protocols. Bonjour makes it easy to discover, publish, and resolve network services with a sophisticated, easy-to-use programming interface that is accessible from Cocoa, Ruby, Python, and other languages.

(back to top)

Contributors

(back to top)

Screenshots

clipbird history
clipbird history

(back to top)