linux-questionnaire/views/Questionnaire/readme.en.html.twig
2015-03-02 20:07:17 +01:00

132 lines
3.6 KiB
Twig

<div class="panel panel-default">
<div class="panel-heading"><h1>Linux Questionnaire</h1></div>
<div class="panel-body"><p>This project provides a questionnaire that determines
the Linux distribution (or BSD system) which matches
your preferences.</p>{% block start %}{% endblock %}</div><ul class="list-group">
<li class="list-group-item"><h2>Contact &amp; Support</h2>
<h3>Project Management</h3>
<ul>
<li><a href="https://lab.deblan.org/client/projects/linux-questionnaire">Redmine</a></li>
</ul>
<h3>Repository Browsers</h3>
<ul>
<li><a href="https://lab.deblan.org/client/projects/linux-questionnaire/repository">Redmine</a></li>
<li><a href="https://guest:guest@svn.deblan.org/websvn/listing.php?repname=linux-questionnaire">WebSVN</a></li>
</ul>
<h3>IRC</h3>
<ul>
<li>Server: <code>ssl.neutralnetwork.org</code>
</li>
<li>Channel: <code>#wiki</code>
</li>
<li><a href="https://ssl.neutralnetwork.org/irc/?channels=%23wiki">Web client</a></li>
</ul>
<h3>Forum</h3>
<ul>
<li><a href="http://www.jeuxvideo.com/forums/1-38-7795760-1-0-1-0-questionnaire-choix-distribution.htm">Official topic</a></li>
</ul>
</li><li class="list-group-item"><h2>Requirements</h2>
<ul>
<li>
<a href="https://www.php.net/">PHP</a> &gt;= 5.4</li>
<li><a href="https://subversion.apache.org/">Apache Subversion</a></li>
<li><a href="https://getcomposer.org/">Composer</a></li>
</ul>
</li><li class="list-group-item"><h2>Installation</h2>
<pre><code>svn co https://svn.deblan.org/svn/linux-questionnaire
cd linux-questionnaire
make
</code></pre>
</li><li class="list-group-item"><h2>Composer</h2>
<p>Composer can maybe be downloaded from your system's repositories.
Else, follow the next instructions:</p>
<h3>Download</h3>
<pre><code># With cURL
curl -sS https://getcomposer.org/installer | php
# With Wget
wget -O - -q https://getcomposer.org/installer | php
</code></pre>
<p>You can now use it with <code>php composer.phar [arguments]</code>.</p>
<h3>Executable</h3>
<pre><code>mv composer.phar composer
chmod +x composer
</code></pre>
<p>Use it with <code>./composer [arguments]</code>.</p>
<h3>Install</h3>
<p>Assuming <code>~/bin</code> exists ans is in <code>$PATH</code>.</p>
<pre><code>mv composer ~/bin
</code></pre>
<h3>Dependencies Installation (from <code>composer.lock</code>)</h3>
<pre><code>composer install
</code></pre>
<h3>Dependencies Update (will change <code>composer.lock</code>)</h3>
<pre><code>composer update
</code></pre>
</li><li class="list-group-item"><h2>Makefile</h2>
<p>A Makefile is provided to automate some tasks.</p>
<ul>
<li>
<code>make</code> will install application's dependencies via Composer,</li>
<li>
<code>make prod</code> will install dependencies without developmenent requirements
and run <code>make optimize</code>,</li>
<li>
<code>make optimize</code> will run Composer's autoloader dump script with classmap
only, without dynamic autoload rules,</li>
<li>
<code>make cs</code> will run PHP code sniffer with PSR-2 conventions.</li>
</ul>
</li><li class="list-group-item"><h2>Development Server</h2>
<p>Use PHP's built-in development server, for example on <code>localhost</code>, port 8080:</p>
<pre><code>cd web
php -S localhost:8080
</code></pre>
</li><li class="list-group-item"><h2>Homepage Update</h2>
<p>When the <code>README.*.md</code> files are updated, we also need to update
the matching views in <code>web/views/Questionnaire/readme.*.html.twig</code>. To do that,
a simple console script was created.</p>
<h3>Help</h3>
<pre><code>app/console generate:readme -h
</code></pre>
<h3>Basic Generation</h3>
<pre><code>app/console generate:readme
</code></pre>
</li></ul></div>