Skip to content
This repository has been archived by the owner on Oct 6, 2023. It is now read-only.

Update needed packages #74

Open
FoxyHawk opened this issue Oct 16, 2018 · 3 comments
Open

Update needed packages #74

FoxyHawk opened this issue Oct 16, 2018 · 3 comments
Assignees

Comments

@FoxyHawk
Copy link
Collaborator

FoxyHawk commented Oct 16, 2018

Tested on the lastest Debian 9 (9.5) and Ubuntu 16 LTS (16.04).

Before proceding for contributing, the following packages must be installed :

Package Comment
git
php php7.0
composer
mariadb-server if use with local database
zip not necessary (only for unzip during install)
PHP extension Comment
php-curl
php-intl for date translation
php-mbstring for doctrine:create:schema:create
php-mysql
php-xml

Should it be added to CONTRIBUTING.md or README.md ?

@halfa
Copy link
Member

halfa commented Oct 16, 2018

It should, an apt oneliner working at least on debian/ubuntu could be added to the CONTRIBUTING.md. Note: I would rather have composer installed locally instead (from my experience).

@superboum
Copy link
Member

superboum commented Oct 29, 2018

In my opinion, feel free to choose the name you prefer, but I think having all installation steps in one place would be beneficial to new contributors, and currently some steps are in README.md. So if you choose to put some information elsewhere, you should also considering migrating or removing the part which is in README.md.

Moreover, a link / reference to where install instructions can be found should be added in the README.md file if you choose to put these information elsewhere, as it is the first thing that you read when you open the github repo.

Generally a CONTRIBUTING.md file does not contain technical information but a Code of Conduct and/or what are the dev processes. Like how you should submit a pull request, etc.

Some times install instructions can be found in an INSTALL.md file, or you can even start a standalone documentation in a doc/ folder with sphinx

And thanks for caring about documentation 👍

@FoxyHawk
Copy link
Collaborator Author

EDIT : Follow up #77, added php-intl extension

@FoxyHawk FoxyHawk self-assigned this Jan 28, 2019
@FoxyHawk FoxyHawk mentioned this issue Feb 1, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants