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:
+
+
Python (newest version)
+
Required pip dependencies (listed below)
+
The latest version of Clipboardy from GitHub
+
+
+
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:
+
+
pyperclip – for clipboard management
+
cryptography – for encryption features
+
validators – to validate URLs
+
customtkinter – for a user-friendly interface
+
+
+
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:
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:
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:
+
+
Follow PEP 8: Make sure your Python code roughly similar to the PEP 8 style
+ guide for Python code to maintain readability.
+
Comment Your Code: Write clear comments explaining your logic, especially in
+ complex sections, to avoid confusion for other developers.
+
Function Documentation: Use docstrings to document your functions and classes,
+ to explain their purpose.
+
+
+
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
+
+
Be Respectful: Treat all contributors with respect.
+ Constructive feedback is always encouraged and helps making the software better.
+
Maintain a Positive Environment: A welcoming environment is great for possible
+ newcomers and encourage them to contribute if they have fixes or ideas.
+
Issue Reporting: If you find any bugs or issues, please report them in the issues section of the GitHub
+ repository. Include as much detail as possible, as it will make the issue easy to understand.
+
+
+
+
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
-
-
Download
+
+
+
+
Download
+
+
+
+
Make sure to read the Download Documentation (not available yet)
+ before. You can donwload the files from GitHub, follow the documentation for more details.
+
+
Due to the programm not beeing released yet, the download isn't available right now.
+
+
+
+
+
Contributing
+
+
+
+
The Clipboardy repository is meant to be beginner friendly and welcoming, therefore
+ contributions to Clipboardy are alyways welcome!
+ To add your own ideas and improvements, please
+ follow this contributing guide first at
+ read other articles for further help.
+
+
+
-
-
-
Make sure to read the Download Documentation (not available yet)
- before. You can donwload the files from GitHub, follow the documentation for more details.
-
-
Due to the programm not beeing released yet, the download isnt available now.