From 575df36492c3d4e92d7afbec53cfa81f34e2e17d Mon Sep 17 00:00:00 2001 From: Mathieu Comandon Date: Thu, 18 Oct 2018 19:12:21 -0700 Subject: [PATCH] Add paragraph to CONTRIBUTING to explain how to run the client from git --- CONTRIBUTING.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 745e18199..1ac38bb39 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -34,6 +34,25 @@ help](https://github.com/lutris/lutris/issues?q=is%3Aissue+is%3Aopen+label%3A%22 might be a bit more technical to resolve but you can always have a look and see if they fit your area of expertise. +Running Lutris from Git +----------------------- + +Running Lutris from a local git repository is easy, it only requires cloning +the repository and executing Lutris from there. + + git clone https://github.com/lutris/lutris + cd lutris + ./bin/lutris -d + +Make sure you have all necessary dependencies installed. It is recommended that +you keep a stable copy of the client installed with your package manager to +ensure that all dependencies are available. +If you are working on a branch implementing new features, such as the `next` +branch, it might introduce new dependencies. Check in the package configuration +files for new dependencies, for example Debian based distros will have their +dependencies listed in `debian/control` and in `lutris.spec` for RPM based +ones. + Formatting your code --------------------