From 2382bfd505a23b21c9d2c118b594d75f3b7ddbca Mon Sep 17 00:00:00 2001 From: kromskii2 <146603192+kromskii2@users.noreply.github.com> Date: Wed, 26 Feb 2025 18:45:32 +0700 Subject: [PATCH] Create README.md --- README.md | 113 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 113 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..90aad22 --- /dev/null +++ b/README.md @@ -0,0 +1,113 @@ + + +# Steel Grade Decoder 🌟 + +**Универсальный декодер марок стали с визуально привлекательным интерфейсом** +[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com//LICENSE) +[![Python version](https://img.shields.io/badge/python-3.6%2B-green.svg)](https://www.python.org/downloads/) + +--- + +## Содержание 📌 +[Введение](#введение) +[Функциональные возможности](#функциональные-возможности) +[Структура проекта](#структура-проекта) +[Установка и использование](#установка-и-использование) +[Пример работы](#пример-работы) +[Технические детали](#технические-детали) +[Планы развития](#планы-развития) +[Авторство и лицензия](#авторство-и-лицензия) + +--- + +## Введение 🌐 +Приветствуем в проекте **Steel Grade Decoder** — инструменте для анализа маркировки сталей российского стандарта. +Приложение позволяет мгновенно определить: +- 📏 Категорию стали (углеродистая/легированная) +- 🏗️ Назначение (конструкционная/инструментальная) +- ✅ Качественную маркировку (стандарт/высококачественная) + +--- + +## Функциональные возможности ✨ +✅ **Автоматическая расшифровка** +✅ **Многоязычная поддержка** (в разработке) +✅ **Графический интерфейс** (в разработке) +✅ **Импорт/экспорт данных** (в разработке) + +--- + +## Структура проекта 📂 +``` +Termux-main/ +├── A.py ➤ Тестовый скрипт вывода (100+ строк "Hello World") +└── Main.py ➤ Основной скрипт декодирования марок стали +``` + +--- + +## Установка и использование 🚀 +1. **Клонирование репозитория** +```bash +git clone https://github.com/your-repo/Termux-main.git +``` + +2. **Запуск декодера** +```bash +python Termux-main/Main.py +``` + +3. **Ввод данных** +``` +Введите марку стали: 45А +``` + +--- + +## Пример работы 📱 +**Ввод:** +```bash +Введите марку стали: УТ6 +``` + +**Вывод:** +``` +Марка стали: УТ6 +Углеродистая: False +Конструкционная: False +Инструментальная: True +Качество: Высококачественная +``` + +--- + +## Технические детали 🛠️ +- **Логика декодирования:** + - Начальные символы определяют тип стали + - Последние символы указывают на качество + - Числовые значения кодируют химический состав + +- **Ограничения:** + ⚠️ Текущая версия поддерживает только российские стандарты (ГОСТ) + ⚠️ Не учитывает специальные маркировки (коррозионностойкие стали) + +--- + +## Планы развития 🚀 +- [ ] Интеграция с международными стандартами (ASTM, JIS) +- [ ] Визуальный интерфейс на PyQt +- [ ] База данных характеристик сталей +- [ ] API для интеграции в CAD-программы + +--- + +## Авторство и лицензия 📝 +**Автор:** Kromskii2 +**Лицензия:** [MIT](LICENSE) —feel free to modify and distribute + +Спасибо за использование **Steel Grade Decoder**! +Если проект вам понравился, поделитесь им с коллегами 💖 + +--- + +**P.S.** Тестовый файл `A.py` содержит 100+ строк "Hello World" для демонстрации базового вывода. Для реального использования обращайтесь к `Main.py`.