docs: added ru, eng docs
This commit is contained in:
42
README.en.md
Normal file
42
README.en.md
Normal file
@@ -0,0 +1,42 @@
|
|||||||
|
# Kawai-Focus
|
||||||
|
A focus app based on the Pomodoro technique.
|
||||||
|
|
||||||
|
The project is currently at the MVP1 development stage:
|
||||||
|
|
||||||
|
- **Pomodoro** — timers for the Pomodoro technique to manage your work sessions and rest breaks;
|
||||||
|
- **Guide** — information on how to use the timers and the app, as well as details about the Pomodoro technique itself;
|
||||||
|
- **App Limiter** — block or limit distracting applications during your work blocks.
|
||||||
|
|
||||||
|
## Tech Stack
|
||||||
|
|
||||||
|
- **Vue.js** — handles the user interface and SQLite operations (frontend);
|
||||||
|
- **Ionic** — provides native UI components and the mobile version;
|
||||||
|
- **Tauri** — the engine powering the desktop version of the application.
|
||||||
|
|
||||||
|
## Author
|
||||||
|
|
||||||
|
**Project Developer:**
|
||||||
|
- **Name and Surname** — Eugene Kaddo
|
||||||
|
- **Nickname** — Arduinum628
|
||||||
|
|
||||||
|
I share detailed insights about the app's development process in my articles on [Kawai-Focus](https://pressanybutton.ru/category/kawai-focus/) at the website [Kod on napkin](https://pressanybutton.ru).
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary><strong>Branch and Commit Naming Conventions</strong></summary>
|
||||||
|
|
||||||
|
Branch example: `nickname/name_task`
|
||||||
|
- **nickname** — your GitHub username;
|
||||||
|
- **name_task** — task name (matches the card title on YouGile).
|
||||||
|
|
||||||
|
Commit example: `refactor: renaming a variable`
|
||||||
|
- **feat:** — a new feature for the application code (excluding build configurations);
|
||||||
|
- **devops:** — build configuration changes (adding, removing, or fixing configurations);
|
||||||
|
- **fix:** — a bug fix in the application code;
|
||||||
|
- **docs:** — documentation changes only;
|
||||||
|
- **style:** — changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc.);
|
||||||
|
- **refactor:** — a code change that neither fixes a bug nor adds a feature (e.g., renaming a variable);
|
||||||
|
- **test:** — adding missing tests or correcting existing tests;
|
||||||
|
- **chore:** — changes to the build process or auxiliary tools and libraries such as documentation generation.
|
||||||
|
|
||||||
|
Conventions are based on [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
|
||||||
|
</details>
|
||||||
@@ -1,7 +1,7 @@
|
|||||||
# kawai-focus-v2
|
# Кавай-Фокус
|
||||||
Kawai-Focus - приложение для фокусировки внимания на основе таймера Pomodoro.
|
Приложение для фокусировки внимания на основе таймера Pomodoro.
|
||||||
|
|
||||||
роект находится на стадии разработки MVP1:
|
Проект находится на стадии разработки MVP1:
|
||||||
|
|
||||||
- **Pomodoro** - таймеры для техники Pomodoro, которая управляет вашим временем работы и перерывами на отдых;
|
- **Pomodoro** - таймеры для техники Pomodoro, которая управляет вашим временем работы и перерывами на отдых;
|
||||||
- **Гайд** - информация о том как использовать таймеры и приложение, а так же о самой технике Pomodoro;
|
- **Гайд** - информация о том как использовать таймеры и приложение, а так же о самой технике Pomodoro;
|
||||||
@@ -20,7 +20,7 @@ Kawai-Focus - приложение для фокусировки внимани
|
|||||||
- **Имя и Фамилия** - Евгений Каддо
|
- **Имя и Фамилия** - Евгений Каддо
|
||||||
- **Никнейм** - Arduinum628
|
- **Никнейм** - Arduinum628
|
||||||
|
|
||||||
Подробно рассказываю о процессе написания кода приложения в своих статьях <a href="https://pressanybutton.ru/category/kawai-focus/">kawai-focus</a> на сайте <a href="https://pressanybutton.ru">Код на салфетке</a>.
|
Подробно рассказываю о процессе написания кода приложения в своих статьях <a href="https://pressanybutton.ru/category/kawai-focus/">Kawai-Focus</a> на сайте <a href="https://pressanybutton.ru">Код на салфетке</a>.
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
<summary>
|
<summary>
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
[package]
|
[package]
|
||||||
name = "kawai-focus"
|
name = "kawai-focus"
|
||||||
version = "0.2.0"
|
version = "0.2.0"
|
||||||
description = "Kawai-Focus - приложение для фокусировки внимания на основе таймера Pomodoro."
|
description = "Кавай-Фокус (Kawai-Focus) - приложение для фокусировки внимания на основе таймера Pomodoro."
|
||||||
authors = ["Arduinum"]
|
authors = ["Arduinum"]
|
||||||
license = "MIT"
|
license = "MIT"
|
||||||
repository = ""
|
repository = ""
|
||||||
|
|||||||
@@ -14,7 +14,7 @@
|
|||||||
"windows": [
|
"windows": [
|
||||||
{
|
{
|
||||||
"label": "main",
|
"label": "main",
|
||||||
"title": "Kawai-Focus",
|
"title": "Кавай-Фокус",
|
||||||
"width": 800,
|
"width": 800,
|
||||||
"height": 600,
|
"height": 600,
|
||||||
"resizable": true,
|
"resizable": true,
|
||||||
@@ -37,7 +37,8 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"shortDescription": "Kawai-Focus - приложение для фокусировки внимания на основе таймера Pomodoro.",
|
"shortDescription": "Кавай-Фокус (Kawai-Focus) - приложение для фокусировки внимания на основе таймера Pomodoro.",
|
||||||
|
"copyright": "© 2026 Eugene Kaddo",
|
||||||
"icon": [
|
"icon": [
|
||||||
"icons/32x32.png",
|
"icons/32x32.png",
|
||||||
"icons/128x128.png",
|
"icons/128x128.png",
|
||||||
|
|||||||
Reference in New Issue
Block a user