FAForever / server

The servercode for the Forged Alliance Forever lobby
http://www.faforever.com
GNU General Public License v3.0
66 stars 61 forks source link

readme lacks information to setup a development environment #860

Open KaukaHan opened 2 years ago

KaukaHan commented 2 years ago

the readme lacks essential information like the python version. witch is not in the default package-manager of my distro. Maybe a script that sets up everything automatically helps attracting more contributers.

Brutus5000 commented 2 years ago

You can look it up in the pipfile https://github.com/FAForever/server/blob/aac3d2c25edac5ad682efbdf887afc8ca5054f84/Pipfile#L43-L44

KaukaHan commented 2 years ago

askaholic helped me setting up everything, but this is a barrier for people who contribute to software for their first time in their life like me. If i had not contacted anyone and just tried to follow the readme, the errors might have turned me down.

Askaholic commented 2 years ago

Yea there were a number of things that came up that should really be in the readme, like required software:

Nowhere does it say that you need to install these things. There were also a bunch of other things that I’ll have to go through our discord conversation again to remember.

Askaholic commented 2 years ago

Ok so from what I helped you with in Discord:

These are kindof all the hoops we had to jump through chronologically. Probably not all of them make sense to go into detail on the server README (such as the faf-stack ones), but at least we should mention the potential issues that might arise and how to fix them.