diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..17ddded --- /dev/null +++ b/Makefile @@ -0,0 +1,36 @@ +COMPOSER ?= composer +BOWER ?= bower + +all: composer +all: bower + +prod: COMPOSER_INSTALL_FLAGS += --no-dev +prod: all optimize + +composer: + @echo + # + # Installing application's dependencies. + # + $(COMPOSER) install $(COMPOSER_INSTALL_FLAGS) +bower: + @echo + # + # Installing application's dependencies. + # + $(BOWER) install + +optimize: + @echo + # + # Optimizing Composer's autoloader, can take some time. + # + $(COMPOSER) dump-autoload --optimize + +update: + @echo + # + # Updating application's depencies. + # + $(COMPOSER) update + $(BOWER) install diff --git a/README.md b/README.md new file mode 100644 index 0000000..c87209e --- /dev/null +++ b/README.md @@ -0,0 +1,83 @@ +GIST +==== + +GIST is an open-source application to share code. + +Requirements +------------ + +* PHP >= 5.4 +* GIT +* Composer +* Bower + +Installation +------------ + + $ git clone https://gitlab.deblan.org/deblan/gist.deblan.org.git + $ cd gist.deblan.org.git + $ make + +Composer +-------- + +Composer can maybe be downloaded from your system's repositories. +Else, follow the next instructions: + +### Download + + # With cURL + curl -sS https://getcomposer.org/installer | php + + # With Wget + wget -O - -q https://getcomposer.org/installer | php + +You can now use it with `php composer.phar [arguments]`. + +### Executable + + mv composer.phar composer + chmod +x composer + +Use it with `./composer [arguments]`. + +### Install + +Assuming `~/bin` exists ans is in `$PATH`. + + mv composer ~/bin + +### Dependencies Installation (from `composer.lock`) + + composer install + +### Dependencies Update (will change `composer.lock`) + + composer update + +Bower +----- + +### Install + + npm install -g bower + +### Dependencies Installation (from `bower.json`) + + bower install + +### Dependencies Update (will change `bower.json`) + + bower update + + +Makefile +-------- + +A Makefile is provided to automate some tasks. + +* `make` will install application's dependencies via Composer, +* `make prod` will install dependencies without developmenent requirements + and run `make optimize`, +* `make optimize` will run Composer's autoloader dump script with classmap + only, without dynamic autoload rules,