Skip to content

Commit 5dfb9e3

Browse files
Merge pull request #9063 from jdarwood007/3.0/fix9041
2 parents 430fad9 + 2239a05 commit 5dfb9e3

File tree

1 file changed

+20
-3
lines changed

1 file changed

+20
-3
lines changed

README.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,22 +11,39 @@ Contributions to documentation are licensed under [CC-by-SA 3](https://creativec
1111

1212
Feel free to fork this repository and make your desired changes.
1313

14-
Please see the [Developer's Certificate of Origin](https://github.com/SimpleMachines/SMF3.0/blob/master/DCO.txt) in the repository:
14+
Please see the [Developer's Certificate of Origin](https://github.com/SimpleMachines/SMF/blob/master/DCO.txt) in the repository:
1515
by signing off your contributions, you acknowledge that you can and do license your submissions under the license of the project.
1616

1717
## Branches organization:
1818
* ***release-3.0*** - is the branch where updates for version 3.0 are applied
1919
* ***release-2.1*** - is the branch where updates for version 2.1 are applied
2020

21+
## Setup
22+
Using official releases provided by our [downloads website](https://download.simplemachines.org/) requires no additional setup. A helpful guide is provided on our [wiki](https://wiki.simplemachines.org/smf/Installing).
23+
24+
If you are attempting to download from the source code provided on our [github](https://github.com/SimpleMachines/SMF), you will need to run composer.
25+
* Install Composer v2 or higher (https://getcomposer.org)
26+
* Install the dependencies with composer as below (Developers read on)
27+
```bash
28+
composer install
29+
```
30+
* If you are intending to do development, you will want to install the developer dependencies, you can append `-dev` to the command like so
31+
```bash
32+
composer install -dev
33+
```
34+
* When updating (`git pull`), you should update the composer and may run into issues if not done so. Developers should add `-dev` to the command
35+
```bash
36+
composer update
37+
```
38+
2139
## How to contribute:
2240
* fork the repository. If you are not used to Github, please check out [fork a repository](https://help.github.com/fork-a-repo).
2341
* branch your repository, to commit the desired changes.
2442
* sign-off your commits, to acknowledge your submission under the license of the project.
2543
* It is enough to include in your commit comment "Signed-off by: " followed by your name and email address (for example: `Signed-off-by: Your Name <[email protected]>`)
2644
* an easy way to do so is to define an alias for the git commit command, which includes -s switch (reference: [How to create Git aliases](https://git.wiki.kernel.org/index.php/Aliases))
2745
* send a pull request to us.
28-
* SMF uses third party libraries via composer, if you want to run a local version, please [install composer first](https://getcomposer.org)
29-
and run `composer install`
46+
* Do not modify the /vendor directory, rather update the appropriate dependency in composer.json, run `composer update`, then commit both composer.json and composer.lock files.
3047

3148
## How to submit a pull request:
3249
* If you want to send a bug fix for version 3.0, send it to the branch ***release-3.0***

0 commit comments

Comments
 (0)