diff --git a/documentation/docs.html b/documentation/docs.html index ca35812..5fd5513 100644 --- a/documentation/docs.html +++ b/documentation/docs.html @@ -6,6 +6,7 @@ Clipboardy Documentation + @@ -14,18 +15,70 @@

Contents

Introduction

+

Please note that some of the guides aren't applicable due to the programm not being released + yet.

Welcome to the Clipboardy documentation. This guide will help you navigate the features and functionality of Clipboardy, along with tutorials on installation and contributing via GitHub.

Note: Installation assumes basic familiarity with programming and GitHub.
+
+

Getting Started

+

This step-by-step guide will help you get Clipboardy up and running.

+ +

Prerequisites

+

To install Clipboardy, you’ll need the following set up:

+
    +
  1. Python (newest version)
    2. +
  2. Required pip dependencies (listed below)
    3. +
  3. The latest version of Clipboardy from GitHub
    4. +
+ +

Step 1: Installing Python

+

If you don’t have Python installed on your system, you can download it from the official Python website. Make sure to select "Add + Python to PATH" during the installation process.

+ +

Step 2: Installing pip Dependencies

+

Clipboardy requires the following dependencies to work properly. You can install them all at once + using the requirements.txt file, found on GitHub, or manually:

+
    +
  1. pyperclip – for clipboard management
    2. +
  2. cryptography – for encryption features
    3. +
  3. validators – to validate URLs
    4. +
  4. customtkinter – for a user-friendly interface
    5. +
+
+

To install these dependencies using the requirements.txt file, wich you will need to + download first, run this command:

+ 
pip install -r requirements.txt
+

Alternatively, you can install them manually by running:

+ 
pip install pyperclip cryptography validators customtkinter
+ +

Step 3: Downloading and Installing Clipboardy

+

Once you’ve installed Python and the necessary dependencies, head to the Clipboardy GitHub repository and go to the + "Releases" + section. Download the latest release of Clipboardy, unzip the files, and navigate to the folder in + your terminal.

+ +

To run Clipboardy, use this command, or just double click clipboardy.py:

+ 
python clipboardy.py
+
+
+

Features

Saving Clipboards

@@ -41,16 +94,79 @@

Auto Save

Functions

-

Next to the saved clip in the main window are two buttons, the first one beeing for coping the +

Next to the saved clip in the main window are two buttons, the first one being for coping the clip again and the second one to delete the clip. To delete all clips, press the "Delete All" button in the buttom section.

-

Quick Search and Advanced Filtering (Upcoming)

+

Searching and filtering

The searchbar allows you to search specific clips by thier name. The filter function is still in development and will be released soon.

+ +
+

Contributing

+

If you want to support the Clipboardy project and add your own ideas and improvements, please follow + these guidelines:

+ +

Getting Started

+

To contribute to Clipboardy, first, fork the repository on GitHub and clone it to your local machine. + You can do this by running:

+ 
git clone https://github.com/YOUR_USERNAME/clipboardy.git
+

Make sure to replace YOUR_USERNAME with your actual GitHub username.

+ +

Branching

+

Before making any new changes, create a new branch for your feature or bug fix. This keeps the master + branch clean and allows for easier collaboration. Use the following command:

+ 
git checkout -b your-feature-name
+ +

Writing Code

+

When writing code, please adhere to the following conventions:

+ + +

Testing

+

Before submitting your changes, ensure that you have tested your code. This helps maintaining our + projects stability. +

+ +

Submitting Changes

+

Once you're satisfied with your changes, commit them with a clear and concise commit message:

+ 
git commit -m "Add a brief description of the changes"
+

Push your changes to your forked repository:

+ 
git push origin your-feature-name
+

Finally, create a pull request on the main repository. Describe the changes you made, why you made + them, and any relevant details that can help us understand your contribution.

+ +

Standard Rules and Expectations

+ + +

Thank You!

+

Your contributions are what make Clipboardy a better programm for everyone! Thank you for your + interest + in contributing to this project and your effort!

+
+
+

GitHub

+

The GitHub repository containing all scripts and files for the installation can be found here

+
diff --git a/documentation/style.css b/documentation/style.css index 712831a..56248c2 100644 --- a/documentation/style.css +++ b/documentation/style.css @@ -122,7 +122,7 @@ pre { @media (max-width: 500px) { .sidebar { - width: 100%; + width: 0; height: auto; position: relative; } diff --git a/favicon.svg b/favicon.svg new file mode 100644 index 0000000..65d9bdc --- /dev/null +++ b/favicon.svg @@ -0,0 +1 @@ +📋 \ No newline at end of file diff --git a/index.html b/index.html index 11f255f..2b1a332 100644 --- a/index.html +++ b/index.html @@ -7,22 +7,31 @@ Clipboardy +

Clipboardy

Advancing clipboards to infinity and beyond

-

Launching on 01.12.2024 🎉

+

Launching soon! 🎉

- - + +
+
+
+

Clipboardy

+

Clipboardy is a user-friendly clipboard management application that allows you to save, organize, and + encrypt your clipboard clips. With features like auto-saving, clipboard monitoring, and support for + various content types, Clipboardy enhances your clipboard experience.

+
+

Privacy

@@ -44,19 +53,39 @@

Modern and Intuitive

Green
-