summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--README.org36
1 files changed, 36 insertions, 0 deletions
diff --git a/README.org b/README.org
new file mode 100644
index 0000000..0c488c1
--- /dev/null
+++ b/README.org
@@ -0,0 +1,36 @@
+* Что это
+ Реализация функционала баллистического компьютера [[https://ace3.acemod.org/wiki/feature/atragmx.html][ATragMX]] из модификации
+ [[https://github.com/acemod/ACE3][ACE3]] для игры ArmA 3.
+
+ #+BEGIN_QUOTE
+ Пользовательский интерфейс не определён и до версии v1.0.0 может меняться.
+ Допускаются варианты cli, tui, gui или вовсе ограничивается аргументами и
+ stdin/stdout/pipe.
+ #+END_QUOTE
+
+* Как пользоваться
+Пока никак. Читай исходники, пробуй catragmx --help или что-то ещё, пока не
+появится документация.
+
+* Ссылки и прочая полезная информация
+- ACE3 atragmx repo sources
+ [[https://github.com/acemod/ACE3/tree/master/addons/atragmx][ACE3/addons/atragmx]]
+ Эталон кода для портирования с языка SQF на C
+- HEMTT
+ [[https://github.com/BrettMayson/HEMTT][github.com/BrettMayson/HEMTT]]
+ Репозиторий системы сборки модификаций для ArmA 3.
+ Так же предоставляет LSP-сервер [[https://en.wikipedia.org/wiki/Language_Server_Protocol][[1]​]] [[https://habr.com/ru/companies/sberbank/articles/838786/][[2]​]] для работы с SQF.
+ Есть готовое [[https://marketplace.visualstudio.com/items?itemName=BrettMayson.hemtt][расширение]] для VSCode. Для emacs разрабатывается [[https://git.hybridlabs.pro/emacs/sqf-mode/][sqf-mode]] с
+ поддержкой hemtt-language-server (требует ручной сборки HEMTT и
+ дополнительной настройки).
+
+* Участие в проекте
+Пока что нет никаких явных требований к стилю и внешнему виду кода.
+Желающие поучаствовать могут написать мне сюда:
+- email: hybrid@hybridlabs.pro
+- XMPP/Jabber: hybrid@hybridlabs.pro
+- Telegram: @OdeTheFuture
+- Steam: desxum (никнейм [RFP]Hybrid или что-то такое)
+
+* Лицензия
+Пока отсутствует, но как появится время изучить этот вопрос - обязательно добавлю.