Skip to content

Commit ff80da8

Browse files
author
Greg Bowler
committed
Add README
1 parent 268bc3e commit ff80da8

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
Command line tools for installing WebEngine.
2+
============================================
3+
4+
One of the main notions of development within PHP.Gt is to remove any barriers that might prevent someone from productively building a prototype. This repository intends to remove all barriers by providing a single `gt` script that contains all of the setup commands to get you going on new and existing projects.
5+
6+
Note: this is a totally optional part of PHP.Gt/WebEngine. You can continue to set up WebEngine projects manually without losing any functionality.
7+
8+
PHP.Gt relies on Composer as the installation medium. Using Composer ensures you have the correct versions of PHP and extensions installed.
9+
10+
With Composer installed, run `composer global require phpgt/installer` to globally install the interface required for creating new WebEngine applications. This will make the `gt` command available to your terminal, which includes the helper commands required for creating new projects and running them.
11+
12+
For the `gt` command to be available globally, ensure that your `~/.config/composer/vendor/bin` directory is in your PATH (or on Windows, `C:\%HOMEPATH%\AppData\Roaming\Composer\vendor\bin`).
13+

0 commit comments

Comments
 (0)