-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
7cfa260
commit f3c5b3e
Showing
1 changed file
with
28 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,31 @@ | ||
LifterLMS Coding Standards | ||
========================== | ||
|
||
LifterLMS Coding Standards (LifterLMS-CS) is a project with rulesets for code style and quality intended for use in LifterLMS projects. | ||
LifterLMS Coding Standards (LifterLMS-CS) is a project with rulesets for code style and quality intended for use in LifterLMS projects. | ||
|
||
|
||
## Installation | ||
|
||
To include in a project require as a development dependency: | ||
|
||
`composer require lifterlms/lifterlms-cs:dev-master --dev` | ||
|
||
Note that Composer won't run configuration scripts in this scenario and the root project needs to take care of it. | ||
|
||
## Developing LifterLMS-CS | ||
|
||
To include in a project and make changes to the LifterLMS-CS project itself: | ||
|
||
Add to your `composer.json` file with the `@dev` tag and reference your local copy of this repository in the repositories block: | ||
|
||
```json | ||
"require-dev": { | ||
"lifterlms/lifterlms-cs": "@dev" | ||
}, | ||
"repositories": [ | ||
{ | ||
"type": "path", | ||
"url": "/absolute/path/to/lifterlms-cs" | ||
} | ||
] | ||
``` |