You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+20-3Lines changed: 20 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,22 +11,39 @@ Contributions to documentation are licensed under [CC-by-SA 3](https://creativec
11
11
12
12
Feel free to fork this repository and make your desired changes.
13
13
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:
15
15
by signing off your contributions, you acknowledge that you can and do license your submissions under the license of the project.
16
16
17
17
## Branches organization:
18
18
****release-3.0*** - is the branch where updates for version 3.0 are applied
19
19
****release-2.1*** - is the branch where updates for version 2.1 are applied
20
20
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
+
21
39
## How to contribute:
22
40
* fork the repository. If you are not used to Github, please check out [fork a repository](https://help.github.com/fork-a-repo).
23
41
* branch your repository, to commit the desired changes.
24
42
* sign-off your commits, to acknowledge your submission under the license of the project.
25
43
* 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]>`)
26
44
* an easy way to do so is to define an aliasfor the git commit command, which includes -s switch (reference: [How to create Git aliases](https://git.wiki.kernel.org/index.php/Aliases))
27
45
* 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.
30
47
31
48
## How to submit a pull request:
32
49
* If you want to send a bug fix for version 3.0, send it to the branch ***release-3.0***
0 commit comments