From 96f10174aec115c3db6fb5d2c1c4e450b61f4825 Mon Sep 17 00:00:00 2001 From: "C. Perreau" Date: Sun, 16 Aug 2020 16:33:10 +0200 Subject: [PATCH] Updated Developer's Guide (markdown) --- Developer's-Guide.md | 33 ++++++++++++++++++++++++++++++++- 1 file changed, 32 insertions(+), 1 deletion(-) diff --git a/Developer's-Guide.md b/Developer's-Guide.md index 6d3f665..ba11886 100644 --- a/Developer's-Guide.md +++ b/Developer's-Guide.md @@ -1 +1,32 @@ -WIP \ No newline at end of file +Welcome to the dev guide ! + +## Technical sum up + +DCS Liberation is coded in Python, with QT5 as UI framework. +It uses pyDCS to generate DCS World missions. + +Before contributing to DCS Liberation, you should also maybe consider contributing to [PyDCS](https://github.com/pydcs/dcs), this is a great way to contribute indirectly to the project. + +## Project history + +DCS Liberation was a project started in 2018 by shdwp, original repo is still available here : https://github.com/shdwp/dcs_liberation +The original UI was different, and the mission generation process was different as well from version 2.0+ + +## Required tools + +* [Python 3.6+](https://www.python.org/downloads/) +* A code Editor for Python. I recommend [PyCharm Community Edition](https://www.jetbrains.com/pycharm/download/#section=windows), you can add plugin for Lua. + +When you install Python, make sure to install pip for dependencies management. + +## Checkout the repository code with git + +**master branch** : Should be even with current release version +**develop branch** : Current version being worked on, might be unstable + +## Installing dependencies + +pip install -r requirements.txt + +## Running from sources +