Skip to content

Commit afeecad

Browse files
committed
docs: Finalize and translate README.md
1 parent 86986b3 commit afeecad

File tree

1 file changed

+32
-15
lines changed

1 file changed

+32
-15
lines changed

README.md

Lines changed: 32 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,41 @@
1-
# Odoo Autocompletion Support
1+
# 🚀 Odoo Autocomplete Plugin
22

3-
**Лицензия:** MIT
3+
An enhanced IntelliJ/PyCharm plugin for Odoo development. It provides advanced autocompletion, code navigation, and inspections to supercharge your workflow. Supports all Odoo versions!
44

5-
## Описание
6-
Плагин для PyCharm/IntelliJ, обеспечивающий автодополнение, навигацию и глубокую интеграцию для всех современных версий Odoo (включая 17.0+). Поддерживает Python, XML, CSV, JS, PO/POT, работу с моделями, действиями, views, группами, меню, отчётами и многое другое.
5+
## ✨ Features
76

8-
- Полная поддержка автодополнения и перехода к определению (Go To Declaration) для моделей, XML ID, actions, views, меню, групп, отчётов, JS-модулей, переводов и данных.
9-
- Совместимость с несколькими версиями Odoo в одном проекте.
10-
- Современная архитектура, высокая производительность.
7+
- **Full Autocompletion:** For Models, Record XML IDs, Actions, Views, Menus, Groups, and more across Python, XML, and CSV files.
8+
- **Go To Declaration:** Instantly navigate to the definition of any Odoo entity.
9+
- **JavaScript Support:** Autocompletion and navigation for JS modules defined with `odoo.define`.
10+
- **Translation Support:** Autocompletion and navigation for `msgid` entries from PO/POT files.
11+
- **Smart Inspections:** Get warnings for missing models, records, JS modules, and translations.
12+
- **High Performance:** Built with a powerful indexing engine for a fast and smooth developer experience.
1113

12-
## Установка
13-
1. Соберите плагин: `./gradlew buildPlugin`
14-
2. Установите JAR из `build/libs/` через PyCharm: `File > Settings > Plugins > Install Plugin from Disk...`
14+
## 🛠️ Installation
1515

16-
## Документация
17-
Подробное описание возможностей и примеры использования — в [documentation/README.md](documentation/README.md)
16+
1. **Build the plugin:**
17+
```bash
18+
./gradlew buildPlugin
19+
```
20+
2. The plugin `.jar` file will be created in the `build/libs/` directory.
21+
3. **Install in your IDE:**
22+
- In PyCharm/IntelliJ, go to `File > Settings > Plugins`.
23+
- Click the gear icon ⚙️ and select **"Install Plugin from Disk..."**.
24+
- Choose the `.jar` file you just built.
1825
19-
## Авторство
20-
Copyright (c) 2024 AlexTkDev
21-
Based on original work by wt-io-it/odoo-pycharm-plugin
26+
## 📚 Documentation
27+
28+
For a detailed list of features, supported entities, and usage examples, please see the full documentation: [documentation/README.md](documentation/README.md).
29+
30+
## 📄 License
31+
32+
This project is licensed under the MIT License. See the [License.txt](License.txt) file for details.
33+
34+
## 🧑‍💻 Authorship
35+
36+
Copyright (c) 2024 AlexTkDev.
37+
38+
Based on the original work by `wt-io-it/odoo-pycharm-plugin`.
2239
2340
# Installing
2441

0 commit comments

Comments
 (0)