Browse Source

Fixed readme. Renamed and uploaded gif

Ivan Arkhipov 5 years ago
parent
commit
03854bbf04
2 changed files with 26 additions and 23 deletions
  1. 26 23
      README.md
  2. 0 0
      assets/common/dwarf.gif

+ 26 - 23
README.md

@@ -1,47 +1,45 @@
-# Клиент игры "Здесь должно быть название, но мы его ещё не придумали"
+# Honourished v0.3.0dev
 
-### Состав команды: 
+### В создании принимают участие:
+Разработчики:
 * Архипов Иван
 * Батманов Игорь
 * Боков Аркадий
-* Кологерманский Егор
+* Кологерманский Егор 
+Дизайнеры:
+* Безребрая Анастасия
 
-Игра была спроектирована в жанре тактической-rpg пошаговой стратегии. На данный момент готовится реализация первого (и основного) сценария игры: свободного сражения между двумя игроками. Сражение представляет собой последовательные действия игроков над их юнитами (предварительно выбранными) на поле из шестиугольников. За основу была взята (но существенно изменена) механика боёв игры Heroes of Might & Magic III.
-
-На данный момент в "Свободном сражении" доступно 3 расы, из которых игроку предлагается выбор - Люди, Восставшие из мёртвых и Warcraft (тестовая раса). Для каждой расы существует свой уникальный набор юнитов и их веток развития. В более-менее полной мере реализованы юниты только расы Людей (для этой расы прописано уже более 60 классов). Раса Мёртвых требует доработки.
-
-В master находится первая стабильная тестовая версия программы, позволяющая запустить её и пройти путь набора отряда для данного сценария. 
+Honourished представляет собой тактическую пошаговую стратегию с элементами rpg. В данный момент идёт разработка первого сценария игры: свободного сражения между двумя игроками. Сражение представляет собой последовательные действия игроков над их юнитами (предварительно выбранными) на поле из шестиугольников. За основу была взята механика боёв игры Heroes of Might & Magic III. Игроку доступны для выбора 2 расы: "Люди" и "Мёртвые", каждая из которых обладает собственным набором юнитов и разветвлённой системой их улучшения. Каждый юнит имеет уникальный набор способностей (умений), характеристик и специфики поведения.
 
 # Установка
+Список доступных версий для установки с их описаниями и ссылками для скачивания доступен по ссылке: http://git.gi1dor.ru/GooseHouse/game-client/releases
 
 ### Windows:
-* Скачать сборку, упакованную в .zip архив: http://files.gi1dor.ru/goosehouse-game.zip
-* Распаковать всё содержимое архива в любую папку 
-* Для запуска использовать файл client.exe
+* Скачать сборку, упакованную в .zip архив (ссылка на последнюю сборку: http://git.gi1dor.ru/attachments/2321e6b4-4236-4790-aae6-3b6c8ff6f7fc)
+* Распаковать всё содержимое архива в любую папку
+* Для запуска использовать файл game.exe
 
 ### Linux Debian-based (Debian ver. >= 8, Ubuntu ver. >= 16.04 LTS, etc.)
-* Открыть терминал и последовательно выполнять команды:
 
+* Скачать .deb пакет с игрой (ссылка на последнюю сборку: http://git.gi1dor.ru/attachments/cd200ce0-0b53-430c-aaf0-c56944ba6ebf)
+* Выполнить команду:
 ```bash
-wget http://files.gi1dor.ru/goosehouse-game.deb
-sudo apt-get -f install ./goosehouse-game.deb
-rm goosehouse-game.deb
+sudo apt-get -f install ./honourished-0.3.0dev-linux.deb
 ```
-
-* Для запуска использовать консольную команду `goosehouse-game`
-
+* Для запуска использовать консольную команду `honourished`
 * В случае, если установка через apt-get -f install не удалась, выполните следующие действия вместо этой команды:
 
 ```bash
-sudo apt-get install qt5-default qt5-image-formats-plugins qt5-style-plugins
+sudo apt-get install libqt5core5a libqt5dbus5 libqt5glib-2.0-0 libqt5gstreamer-1.0-0 libqt5gui5 libqt5multimedia5 libqt5network5 libqt5svg5 libqt5widgets5 libqt5multimedia5 libqt5gstreamer-1.0-0 libqt5multimedia5-plugins gstreamer1.0-nice gstreamer1.0-plugins-good
+```
+```bash
 dpkg -i ./goosehouse-game.deb
 ```
 
-
-## Структура папок проекта:
+## Структура директорий проекта:
 
 #### Папка *assets* : 
-В этой папке содержатся все графические файлы, связанные с проектом. Часть из них (версии для деплоя) собираются в специальные файлы ресурсов для каждой сцены, которые загружаются вместе со сценой.
+В этой папке содержатся все графические файлы, элементы интерфейса, озвучка и остальные ресурсы, связанные с проектом. Они собираются на этапе сборки проекта в специальные файлы ресурсов, которые программа загружает и использует в процессе выполнения.
 
 #### Папка *include* :
 Эта папка содержит в себе все .h файлы приложения - все интерфейсы классов приложения (исключения - .h файлы, связанные с .ui сценами, они хранятся вместе с этими сценами)
@@ -53,4 +51,9 @@ dpkg -i ./goosehouse-game.deb
 В папке ui размещены все файлы графических сцен проекта. Каждая сцена состоит из 3-х файлов - .ui, .cpp и .h. Одна логическая сцена (главное меню, к примеру), может состоять из нескольких физических, которые накладываются друг на друга (сцена анимированного фона, сцена меню, расположенного по центру)
 
 #### Папка *res* :
-В ней находятся специальные файлы .qrc, содержащие информацию о тех файлах из */аssets*, которые будут собраны в файл ресурсов.
+В ней находятся специальные файлы .qrc, содержащие информацию о тех файлах из */аssets*, которые будут собраны в файлы ресурсов (.gtr)
+
+
+#### Файл client.pro - файл qmake проекта, именно в нём прописаны скрипты сборки ресурсов, указаны собираемые файлы исходных кодов, подключаемые библиотеки и system-specific указания системе сборки qmake.
+
+[![логотип](http://www.files.gi1dor.ru/dwarf.gif)]

+ 0 - 0
assets/common/dwarf_adventurer_by_vertibirdo-d9dr1c0.gif → assets/common/dwarf.gif