Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation for installing and creating confgen.phar #32

Merged
merged 2 commits into from
Nov 16, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
/vendor
/composer.lock
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -293,6 +293,25 @@ See also [configuration section](#configuration) above for more details.

## Install

You can simply download a pre-compiled and ready-to-use version as a Phar
to any directory.
Simply download the latest `confgen.phar` file from our
[releases page](https://github.com/clue/confgen/releases):

[Latest release](https://github.com/clue/confgen/releases/latest)

That's it already. You can now verify everything works by running this:

```bash
$ cd ~/Downloads
$ php confgen.phar -h

$ chmod +x confgen.phar
$ sudo mv confgen.phar /usr/local/bin/confgen
```

Alternatively, you can also use this project as a library to integrate this into
an existing application.
The recommended way to install this library is [through Composer](https://getcomposer.org).
[New to Composer?](https://getcomposer.org/doc/00-intro.md)

Expand All @@ -305,6 +324,9 @@ extensions and supports running on legacy PHP 5.3 through current PHP 7+ and
HHVM.
It's *highly recommended to use PHP 7+* for this project.

> If you want to create the above `confgen.phar` locally, you have to clone
this repository and run `composer build`.

## Tests

To run the test suite, you first need to clone this repo and then install all
Expand Down
8 changes: 8 additions & 0 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,5 +22,13 @@
},
"require-dev": {
"phpunit/phpunit": "~4.8.35 || ~5.7 || ~6.4"
},
"config": {
"platform": {
"php": "5.3.7"
}
},
"scripts": {
"build": "rm -f confgen*.phar && composer install --no-dev && phar-composer build . && composer install"
}
}
Loading