Documentation

This commit is contained in:
Michael RICOIS 2013-10-30 13:23:31 +00:00
parent 4d32d30a14
commit f53575a435
2 changed files with 76 additions and 30 deletions

76
docs/README Normal file
View File

@ -0,0 +1,76 @@
README
======
This directory should be used to place project specfic documentation including
but not limited to project notes, generated API/phpdoc documentation, or
manual files generated or hand written. Ideally, this directory would remain
in your development environment only and should not be deployed with your
application to it's final production location.
Setting Up Your VHOST
=====================
The following is a sample VHOST you might want to consider for your project.
<VirtualHost *:80>
ServerName sdciblage.sd.dev
AddDefaultCharset utf-8
DirectoryIndex index.php
SetEnv APPLICATION_ENV "development"
DocumentRoot "WORKSPACE/sdciblage/public"
<Directory "WORKSPACE/sdciblage/public/">
AllowOverride none
Order allow,deny
Allow from all
<IfModule mod_rewrite.c>
RewriteEngine On
RewriteCond %{REQUEST_URI} ^/favicon.ico$ [OR]
RewriteCond %{REQUEST_FILENAME} -s [OR]
RewriteCond %{REQUEST_FILENAME} -l [OR]
RewriteCond %{REQUEST_FILENAME} -d
RewriteRule ^.*$ - [NC,L]
RewriteRule ^.*$ index.php [NC,L]
</IfModule>
</Directory>
# Possible values include: debug, info, notice, warn, error, crit, alert, emerg.
LogLevel notice
ErrorLog "logs/sdciblage-error.log"
CustomLog "logs/sdciblage-access.log" common
</VirtualHost>
Installation
============
Give sample detail on the installation
Project
=======
The purpose of this application is to select a list of company and extract information.
On the interface, filter is apply for the selection. And the deliver file, a csv file, give all
the detail of companies.
Structure
---------
- Zend Framework version 1.x
Assets
------
- JQuery 1.10.1
- JQuery-UI 1.10.3
Development
-----------
Library
=======
Scores_Ciblage
Scores_Enrichissement
Scores_Fields

View File

@ -1,30 +0,0 @@
README
======
This directory should be used to place project specfic documentation including
but not limited to project notes, generated API/phpdoc documentation, or
manual files generated or hand written. Ideally, this directory would remain
in your development environment only and should not be deployed with your
application to it's final production location.
Setting Up Your VHOST
=====================
The following is a sample VHOST you might want to consider for your project.
<VirtualHost *:80>
DocumentRoot "C:/workspace/sdciblage2/public"
ServerName .local
# This should be omitted in the production environment
SetEnv APPLICATION_ENV development
<Directory "C:/workspace/sdciblage2/public">
Options Indexes MultiViews FollowSymLinks
AllowOverride All
Order allow,deny
Allow from all
</Directory>
</VirtualHost>