From 7769ce557fd48af0950283c13c4513728b579dec Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=D0=91=D0=B5=D0=BB=D0=BB=D0=B0=D0=B2=D0=B8=D0=BD=20=D0=92?= =?UTF-8?q?=D0=B8=D0=BA=D1=82=D0=BE=D1=80?= Date: Tue, 21 Apr 2015 17:38:10 +0300 Subject: [PATCH] README - project conventions, project creation instruction --- README.md | 33 ++++++++++++++++++++++++++++++++- 1 file changed, 32 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5fb9b5c..e893c67 100644 --- a/README.md +++ b/README.md @@ -56,4 +56,35 @@ gradlew.bat build В Idea 14.1 появилось дейтсвие "Execute Gradle Task", которое позволяет выполнять такси без указания конфигурации запуска. -### Создание своего проекта \ No newline at end of file +### Основные соглашения + +* Группа проекта в gradle-скрипте сообтветсует основному пакету +* Основной пакет содержит классы Product и Version +* Файлы с версией (version.properties) и переопределенными классами (register.json) + находятся в ресурсах по след. пути META-INF/ncore-product/[группа проекта] +* В корне проекта обязательно присутствет файл ncore-properties.xml, содержайший свойство + product.name. + + +### Создание проекта myproject на основе sample + +1. Создать директорию myproject и скопировать в нее содержимое ncore-sample + +2. Удалить директорию .git + +3. В build.gradle изменить значение group +``` +group = 'biz.redsoft.myproject' +``` +4. В settings.gradle изменить значение rootProject.name +``` +rootProject.name = 'myproject' +``` + +5. В ncore-properties.xml изменить значение product.name +``` +myproject +``` +6. В исходниках пакет biz.redsoft.sample заменить на biz.redsoft.myproject (это можно сделать в IDE) + +7. В META-INF/ncore-product изменить имя диектории biz.redsoft.sample на biz.redsoft.myproject