Skip to content

Commit 8be3021

Browse files
committed
Minor fixes
1 parent 90fe813 commit 8be3021

File tree

6 files changed

+26
-10
lines changed

6 files changed

+26
-10
lines changed

CITATION.cff

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# This CITATION.cff file was generated with cffinit.
2+
# Visit https://bit.ly/cffinit to generate yours today!
3+
4+
cff-version: 1.2.0
5+
title: VisualCrypto - A toolkit for image-based secret sharing
6+
message: "If you use this software, please cite it as below."
7+
type: software
8+
authors:
9+
- given-names: Christian
10+
family-names: Coduri
11+
url: 'https://github.com/coduri/VisualCrypto'
12+
keywords:
13+
- visual cryptography
14+
- random grid
15+
- visual secret sharing
16+
license: MIT
17+
version: 1.0.0
18+
date-released: '2025-02-23'
File renamed without changes.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
[![Python 3.8+](https://img.shields.io/badge/Python-3.8%2B-blue)](https://www.python.org/downloads/)
1414
[![Documentation Available](https://img.shields.io/badge/Documentation-Available-green)](https://coduri.github.io/VisualCrypto/)
1515
[![Contributions Welcome](https://img.shields.io/badge/Contributions-Welcome-orange)](https://coduri.github.io/VisualCrypto/pages/contributing/)
16-
[![License](https://img.shields.io/badge/License-MIT-red)](https://github.com/coduri/VisualCrypto/blob/main/LICENSE.txt)
16+
[![License](https://img.shields.io/badge/License-MIT-red)](https://github.com/coduri/VisualCrypto/blob/main/LICENSE)
1717

1818

1919
</div>

docs/pages/contributing.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -44,13 +44,12 @@ Create a new Python script for your VSS scheme. Follow the structure of existing
4444
raise ValueError(f"Invalid decryption operation: {operation}. Choose 'XOR' or 'OR'.")
4545
```
4646

47-
#### **Support Functions** (Refer to [Web Interface Integration](web_interface_integration.md#required-support-functions))
47+
#### **Support Functions**
4848
- **`get_description()`** → Provides details and references for the scheme.
4949
- **`get_requirements()`** → Specifies input requirements for encryption and decryption.
50-
- **`get_config()`** → Defines algorithm configurations for integration.
51-
52-
50+
- **`get_config()`** → Defines algorithm configurations for integration.
5351

52+
Refer to [Web Interface Integration](web_interface_integration.md#required-support-functions)
5453

5554
---
5655

@@ -74,7 +73,6 @@ Once your script is implemented, update `algo_interface.py` by:
7473
}
7574
```
7675

77-
7876
---
7977

8078
### Test Your Algorithm
@@ -104,6 +102,6 @@ Before submitting a Pull Request:
104102
---
105103

106104
## Thank You for Contributing!
107-
Contributions to this project are greatly appreciated. For any questions, feel free to open an issue or reach out to the maintainers- Contact details can be found in the footer of this documentation.
105+
Contributions to this project are greatly appreciated. For any questions, feel free to open an issue or reach out to the maintainers. Contact details can be found in the footer of this documentation.
108106

109107
---

mkdocs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
site_name: VisualCrypto Documentation
2-
site_description: Documentation of VisualCrypto a repository that contains Visual Secret Sharing Schemes
2+
site_description: Documentation of VisualCrypto, a repository containing a collection of Visual Cryptography and Random Grid schemes.
33
site_url: https://coduri.cc
44
site_author: Christian Coduri
55
repo_url: https://github.com/coduri/VisualCrypto
@@ -33,7 +33,7 @@ theme:
3333
primary: blue
3434

3535
nav:
36-
- 'Index': index.md
36+
- 'Welcome': index.md
3737
- 'Introduction to VSS Schemes': pages/introductionVSS.md
3838
- 'Getting Started': pages/getting_started.md
3939
- 'Developer Guide':

web_app/static/css/style.css

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ body {
33
font-family: Arial, sans-serif;
44
margin: 0;
55
padding: 0;
6-
background-color: #f9f9f9;
6+
background-color: #f4f7fc;
77
color: #333;
88
}
99

0 commit comments

Comments
 (0)