fix: update README.md to English and improve clarity

This commit is contained in:
2025-09-01 03:16:48 +07:00
parent 5330510977
commit a444d44bd3
2 changed files with 31 additions and 151 deletions

View File

@@ -1,50 +1,50 @@
# QuestLang Syntax Highlighting
Расширение VS Code для подсветки синтаксиса языка QuestLang - специализированного языка для создания интерактивных текстовых квестов.
VS Code extension for syntax highlighting of QuestLang - a specialized language for creating interactive text quests.
## Возможности
## Features
-**Подсветка синтаксиса** для файлов `.ql`
- 🔤 **Поддержка русских ключевых слов**
- 💬 **Подсветка комментариев** (`//`)
- 🎨 **Цветовое выделение строк и чисел**
- 🔧 **Автоматическое закрытие скобок**
- 📐 **Автоматические отступы**
-**Syntax highlighting** for `.ql` files
- 🔤 **Support for Russian keywords**
- 💬 **Comment highlighting** (`//`)
- 🎨 **Color highlighting for strings and numbers**
- 🔧 **Automatic bracket closing**
- 📐 **Automatic indentation**
## Поддерживаемые элементы языка
## Supported Language Elements
### Ключевые слова
### Keywords
- `квест`, `цель`, `граф`, `узлы`, `начало`, `конец`
- `тип`, `описание`, `переходы`, `варианты`, `название`
- `начальный`, `действие`, `концовка`
### Синтаксические элементы
- Строки в двойных кавычках: `"Текст"`
- Числа: `123`, `45.67`
- Комментарии: `// это комментарий`
- Скобки: `{}`, `[]`, `()`
- Разделители: `;`, `:`, `,`
### Syntax Elements
- Strings in double quotes: `"Text"`
- Numbers: `123`, `45.67`
- Comments: `// this is a comment`
- Brackets: `{}`, `[]`, `()`
- Delimiters: `;`, `:`, `,`
## Пример кода
## Code Example
```questlang
квест МойКвест;
цель "Описание цели квеста";
квест MyQuest;
цель "Quest objective description";
граф {
узлы {
старт: {
тип: начальный;
описание: "Начало приключения";
описание: "Beginning of the adventure";
переходы: [выбор];
}
выбор: {
тип: действие;
описание: "Что вы будете делать?";
описание: "What will you do?";
варианты: [
("Идти направо", правый_путь),
("Идти налево", левый_путь)
("Go right", правый_путь),
("Go left", левый_путь)
];
}
}
@@ -55,29 +55,17 @@
конец;
```
## Установка
## Installation
1. Откройте VS Code
2. Перейдите в Extensions (Ctrl+Shift+X)
3. Найдите "QuestLang Syntax Highlighting"
4. Нажмите Install
1. Open VS Code
2. Go to Extensions (Ctrl+Shift+X)
3. Search for "QuestLang Syntax Highlighting"
4. Click Install
## Использование
## Usage
После установки расширения все файлы с расширением `.ql` будут автоматически распознаваться как файлы QuestLang с подсветкой синтаксиса.
After installing the extension, all files with `.ql` extension will be automatically recognized as QuestLang files with syntax highlighting.
## Разработка
Для разработки расширения:
```bash
git clone <repo-url>
cd vscode-extension
npm install
```
Затем нажмите F5 в VS Code для запуска Extension Development Host.
## Лицензия
## License
MIT