README - project conventions, project creation instruction

This commit is contained in:
Беллавин Виктор
2015-04-21 17:38:10 +03:00
parent 27b7db3c8b
commit 7769ce557f

View File

@ -56,4 +56,35 @@ gradlew.bat build
В Idea 14.1 появилось дейтсвие "Execute Gradle Task", которое позволяет выполнять такси без указания конфигурации запуска. В Idea 14.1 появилось дейтсвие "Execute Gradle Task", которое позволяет выполнять такси без указания конфигурации запуска.
### Создание своего проекта ### Основные соглашения
* Группа проекта в 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
```
<entry key="product.name">myproject</entry>
```
6. В исходниках пакет biz.redsoft.sample заменить на biz.redsoft.myproject (это можно сделать в IDE)
7. В META-INF/ncore-product изменить имя диектории biz.redsoft.sample на biz.redsoft.myproject