Skip to content

Commit bfcd097

Browse files
authored
Add info about the skeleton to README.md
1 parent 87d8da6 commit bfcd097

1 file changed

Lines changed: 16 additions & 2 deletions

File tree

README.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Toolforge Bundle
22
================
33

4-
A Symfony 4 bundle that provides some common parts of web-based tools in Wikimedia Toolforge.
4+
A Symfony 4/5 bundle that provides some common parts of web-based tools in Wikimedia Toolforge.
55

66
Features:
77

@@ -44,7 +44,21 @@ or on [Phabricator](https://phabricator.wikimedia.org/tag/community-tech) (tagge
4444

4545
## Installation
4646

47-
Install the code (in an existing Symfony project):
47+
### New project
48+
49+
To get a new project up and running quickly
50+
first make sure you've got [Composer](https://getcomposer.org) and the [Symfony CLI](https://symfony.com/download) installed
51+
and then use the [Toolforge Skeleton](https://packagist.org/packages/wikimedia/toolforge-skeleton):
52+
53+
composer create-project wikimedia/toolforge-skeleton ./my-cool-tool
54+
cd my-cool-tool
55+
symfony server:start -d
56+
57+
Navigate to http://localhost:8000 and you should see your new tool up and running.
58+
59+
### Existing project
60+
61+
Install the code in an existing Symfony project:
4862

4963
composer require wikimedia/toolforge-bundle
5064

0 commit comments

Comments
 (0)