#5 [Gi1dor/master => master] Добавление README.md в папках include и source

Merged
Endevir merged 6 commits from endevir/master into GooseHouse/master 6 years ago
5 changed files with 41 additions and 4 deletions
  1. 29 4
      README.md
  2. 3 0
      include/README.md
  3. 4 0
      include/gui/README.md
  4. 2 0
      include/units/README.md
  5. 3 0
      source/README.md

+ 29 - 4
README.md

@@ -1,4 +1,10 @@
-### Клиент игры - "Здесь должно быть название, но мы его ещё не придумали"
+# Клиент игры "Здесь должно быть название, но мы его ещё не придумали"
+
+### Состав команды: 
+* Архипов Иван
+* Батманов Игорь
+* Боков Аркадий
+* Кологерманский Егор
 
 Игра была спроектирована в жанре тактической-rpg пошаговой стратегии. На данный момент готовится реализация первого (и основного) сценария игры: свободного сражения между двумя игроками. Сражение представляет собой последовательные действия игроков над их юнитами (предварительно выбранными) на поле из шестиугольников. За основу была взята (но существенно изменена) механика боёв игры Heroes of Might & Magic III.
 
@@ -6,8 +12,27 @@
 
 В master находится первая стабильная тестовая версия программы, позволяющая запустить её и пройти путь набора отряда для данного сценария. 
 
-Актуальная сборка для Windows находится по ссылке: https://yadi.sk/d/AZjnvuz03TWYPW
+##### Актуальная сборка для Windows находится по ссылке: https://yadi.sk/d/AZjnvuz03TWYPW
+
+##### Сборка для Linux существует, но требует доработки.
+
+##### Читайте CONTRIBUTING.md (должно появиться в ближайшее время) для получения информации об участии в проекте
+
+
+## Ветки развития юнитов расы людей:
+
+### Ветка Лучника
+![image](http://git.gi1dor.ru/GooseHouse/game-client/raw/81ece99571eb24a336633bfbf7173b6f68521fa2/assets/unittrees/human-archer.png)
+
+### Ветка Мага
+![image](http://git.gi1dor.ru/GooseHouse/game-client/raw/81ece99571eb24a336633bfbf7173b6f68521fa2/assets/unittrees/human-mage.png)
+
+### Ветка Всадника
+![image](http://git.gi1dor.ru/GooseHouse/game-client/raw/81ece99571eb24a336633bfbf7173b6f68521fa2/assets/unittrees/human-rider.png)
+
+### Ветка Изгоя
+![image](http://git.gi1dor.ru/GooseHouse/game-client/raw/81ece99571eb24a336633bfbf7173b6f68521fa2/assets/unittrees/human-rogue.png)
 
-Сборка для Linux существует, но требует доработки.
+### Ветка Воина 
+![image](http://git.gi1dor.ru/GooseHouse/game-client/raw/81ece99571eb24a336633bfbf7173b6f68521fa2/assets/unittrees/human-warrior.png)
 
-Читайте CONTRIBUTING.md для получения информации об участии в проекте

+ 3 - 0
include/README.md

@@ -0,0 +1,3 @@
+# Директория /include
+В этой директории находятся и размещаются все текущие заголовочные файлы проекта. 
+Заголовочные файлы одной тематики должны быть сгруппированы в папки (пример: /include/gui, /include/units)

+ 4 - 0
include/gui/README.md

@@ -0,0 +1,4 @@
+# Папка /include/gui
+В этой папке находятся все заголовочные файлы, связанные с отрисовкой и обработкой графической составляющей. Здесь же находятся файлы форм QtDesigner. 
+
+### Ответственный за gui - Архипов Иван

+ 2 - 0
include/units/README.md

@@ -0,0 +1,2 @@
+# Папка /include/units
+В этой папке находятся заголовочные файлы классов *механик* юнитов. Важно понимать, что механики юнитов и классы юнитов - разные вещи. Под классами юнитов понимаются их игровые классы - их на данный момент более 70. Под механиками юнитов понимаются классы c++, реализующие конкретную механику действий юнита. На данный момент подготовлена реализация пяти механик. Каждый игровой класс обязан иметь механику.

+ 3 - 0
source/README.md

@@ -0,0 +1,3 @@
+# Папка /source 
+В этой папке находятся все исходные коды проекта. Они же подключаются в файле проекта /client.pro
+Повторяют структуру директории /include.