summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJason Lee <changjin9792@gmail.com>2023-03-29 15:44:50 +0800
committerJason Lee <changjin9792@gmail.com>2023-03-29 15:44:50 +0800
commita36dd8302972a9e27681f21f7bcc4ab5382a0ff5 (patch)
treea7d6b5ffb387c948af52b268014d0eb4df075b75
parent4872ea8791110614a2d0ace4705f4f9a1ddc0c30 (diff)
readme
-rw-r--r--README.md5
-rw-r--r--background-images/README.md20
-rw-r--r--background-images/dark-chinese-door-demo.pngbin0 -> 4283800 bytes
-rw-r--r--background-images/dark-chinese-door.jpegbin0 -> 175901 bytes
4 files changed, 25 insertions, 0 deletions
diff --git a/README.md b/README.md
index 6fc4cbc..7cb7653 100644
--- a/README.md
+++ b/README.md
@@ -43,6 +43,7 @@ To see the current version, enter `girok --version`.
- [🚀 Installation](#-Installation)
- [🔥 Get Started !](#-get-started)
- [🪟 0. Fancier UI](#fancierui)
+ - [Contribute your background image!](#contributeimage)
- [🙏 1. help command](#helpcommand)
- [🔒 2. Register](#register)
- [🔓 3. Login / Logout](#loginandlogout)
@@ -120,6 +121,10 @@ As I just found out about this transparency (and I'm lazy), I'll leave the below
p.s) Please upload images great for backgrounds in the issue (make sure to keep the copyrights) so that other people can see!
+### Contribute your favorite background images! <a name="contributeimage"></a>
+
+If you think your background image is awesome, you can contribute by sharing it with other people! Please visit the [detailed guide](https://github.com/noisrucer/girok/tree/develop/background-images/README.md).
+
## 🙏 1. Help command <a name="helpcommand"></a>
In order to see **all the commands** of **Girok**, enter `girok --help` in your terminal.
diff --git a/background-images/README.md b/background-images/README.md
new file mode 100644
index 0000000..7422f09
--- /dev/null
+++ b/background-images/README.md
@@ -0,0 +1,20 @@
+# Girok Background Images Archive
+
+1. `IG: @nush22.jpeg`
+
+- Transparency: `54%`
+- blur: `20%`
+- source file: `background-images/dark-chinese-door.jpeg`
+
+![](/background-images/dark-chinese-door-demo.png)
+
+# To Contribute
+
+Here is a repository for awesome background images for the **Girok**. You can create a **PR** containing the below information.
+
+1. The screenshot of the applied background image (as either `jpg/jpeg` or `png`) displaying the calendar view.
+2. (Optional)Brief title summarizing the image (ex. dark-sunset-house)
+3. Detailed information about the settings including `transparency` and `blur`.
+4. The statement that it does not breach any copyrights.
+5. **Credits** to the creator of the image if you need one (even if it's from Unsplash, let's respect the creator by giving credits!
+6. Include the source file path (ex. `background-images/dark-chinese-door.jpeg`).
diff --git a/background-images/dark-chinese-door-demo.png b/background-images/dark-chinese-door-demo.png
new file mode 100644
index 0000000..81f756e
--- /dev/null
+++ b/background-images/dark-chinese-door-demo.png
Binary files differ
diff --git a/background-images/dark-chinese-door.jpeg b/background-images/dark-chinese-door.jpeg
new file mode 100644
index 0000000..f296a6c
--- /dev/null
+++ b/background-images/dark-chinese-door.jpeg
Binary files differ