From c37db8fdd3b39dd6ebc5d5c6005d5e78c1f938f1 Mon Sep 17 00:00:00 2001
From: veselcraft <veselcraft@icloud.com>
Date: Tue, 7 Dec 2021 14:52:12 +0300
Subject: [PATCH] Readme: Added a instruction how to create a themepack

---
 themepacks/readme.md    | 47 +++++++++++++++++++++++++++++++++++++++++
 themepacks/readme.ru.md | 47 +++++++++++++++++++++++++++++++++++++++++
 2 files changed, 94 insertions(+)
 create mode 100755 themepacks/readme.md
 create mode 100755 themepacks/readme.ru.md

diff --git a/themepacks/readme.md b/themepacks/readme.md
new file mode 100755
index 00000000..f5408a58
--- /dev/null
+++ b/themepacks/readme.md
@@ -0,0 +1,47 @@
+# OpenVK Themepacks
+
+This folder contains all themes that can be used by any user on instance.
+
+## How do i create the theme?
+
+Create a directory, the name of which should contain only Latin letters and numbers, and create a file there `theme.yml`, and fill it with the following content:
+
+```yaml
+id: vk2007
+version: "0.0.1.0"
+openvk_version: 0
+enabled: 1
+metadata:
+    name:
+        _: "V Kontakte 2007"
+        en: "V Kontakte 2007"
+        ru: "В Контакте 2007"
+    author: "Veselcraft"
+    description: "V Kontakte-stylized theme by 2007 era"
+```
+
+**Where:**
+
+`id` is the name of the folder
+
+`version` - version of the theme
+
+`openvk_version` - version OpenVK *(it is necessary to leave the value 0)*
+
+`metadata`:
+
+* `name` - the name of the theme for the end user. Inside it you can leave names for different languages. `_` (underscore) - for all languages.
+
+Next, in `stylesheet.css` you can insert any CSS code, with which you can change the elements of the site. If you need additional pictures or resources, just create a `res` folder, and access the resources via the `/themepack/{directory name}/{theme version}/resource/{resource}` path.
+
+To support the New Year's mood, which turns on automatically from December 1st to January 15th, create the file `xmas.css` in the `res` folder, and make the necessary changes.
+
+**After all, the directory hierarchy with the topic should look like this:**
+
+```
+vk2007:
+- res
+  - {resources}
+- stylesheet.css
+- theme.yml
+```
diff --git a/themepacks/readme.ru.md b/themepacks/readme.ru.md
new file mode 100755
index 00000000..b9b0122e
--- /dev/null
+++ b/themepacks/readme.ru.md
@@ -0,0 +1,47 @@
+# OpenVK Themepacks
+
+Эта папка содержит все темы, которые могут быть использованы пользователями инстанса.
+
+## Как создавать свои темы?
+
+Создайте директорию, название которого должно содержать только латинские буквы и цифры, и создайте там файл `theme.yml`, и заполняем его следующим содержанием:
+
+```yaml
+id: vk2007
+version: "0.0.1.0"
+openvk_version: 0
+enabled: 1
+metadata:
+    name:
+        _: "V Kontakte 2007"
+        en: "V Kontakte 2007"
+        ru: "В Контакте 2007"
+    author: "Veselcraft"
+    description: "V Kontakte-stylized theme by 2007 era"
+```
+
+**Где:** 
+
+`id` - название папки
+
+`version` - версия темы
+
+`openvk_version` - версия OpenVK *(стоит оставить 0)*
+
+`metadata`:
+
+* `name` - имя темы для конечного пользователя. Внутри её можно оставить названия для разных языков. `_` (нижнее подчеркивание) - для всех языков.
+
+Далее, в `stylesheet.css` вставляем любой CSS код, с помощью которого вы можете изменить элементы сайта. Если вам нужны дополнительные картинки или ресурсы, то для этого просто создайте папку `res`, и в CSS коде обращайтесь к ресурсам через путь `/themepack/{название директории}/{версия темы}/resource/{ресурс}`.
+
+Для поддержки новогоднего насторения, которое включается автоматически с 1 декабря по 15 января, создайте файл `xmas.css` в папку `res`, и внесите вам нужные изменения.
+
+**В конце концов, иерархия директории с темой должна выглядеть вот так:**
+
+```
+vk2007:
+- res
+  - {ресурсы}
+- stylesheet.css
+- theme.yml
+```