linux-questionnaire/README.en.md

115 lines
2.5 KiB
Markdown
Raw Permalink Normal View History

2015-03-02 20:07:17 +01:00
Linux Questionnaire
===================
This project provides a questionnaire that determines
the Linux distribution (or BSD system) which matches
your preferences.
Contact & Support
-----------------
### Project Management
* [Redmine](https://lab.deblan.org/client/projects/linux-questionnaire)
### Repository Browsers
* [Redmine](https://lab.deblan.org/client/projects/linux-questionnaire/repository)
* [WebSVN](https://guest:guest@svn.deblan.org/websvn/listing.php?repname=linux-questionnaire)
### IRC
* Server: `ssl.neutralnetwork.org`
* Channel: `#wiki`
* [Web client](https://ssl.neutralnetwork.org/irc/?channels=%23wiki)
### Forum
* [Official topic](http://www.jeuxvideo.com/forums/1-38-7795760-1-0-1-0-questionnaire-choix-distribution.htm)
Requirements
------------
* [PHP](https://www.php.net/) >= 5.4
* [Apache Subversion](https://subversion.apache.org/)
* [Composer](https://getcomposer.org/)
Installation
------------
svn co https://svn.deblan.org/svn/linux-questionnaire
cd linux-questionnaire
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
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,
* `make cs` will run PHP code sniffer with PSR-2 conventions.
Development Server
------------------
Use PHP's built-in development server, for example on `localhost`, port 8080:
cd web
php -S localhost:8080
Homepage Update
---------------
When the `README.*.md` files are updated, we also need to update
the matching views in `web/views/Questionnaire/readme.*.html.twig`. To do that,
a simple console script was created.
### Help
app/console generate:readme -h
### Basic Generation
app/console generate:readme