From afa7fc2aef5301fd8d743406937e739d2e7343f2 Mon Sep 17 00:00:00 2001 From: Exodus 4D Date: Sun, 20 Sep 2015 21:12:44 +0200 Subject: [PATCH] fixed layout bugs README.md --- README.md | 72 +++++++++++++++++++++++++++++-------------------------- 1 file changed, 38 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index 38ae36d5..19dc7079 100644 --- a/README.md +++ b/README.md @@ -14,23 +14,24 @@ I will provide all required dumps once the beta phase is over. ## Requirements #### APACHE Webserver - - PHP 5.3.4 or higher - - PCRE 8.02 or higher (usually shipped with PHP package, but needs to be additionally updated on CentOS or Red Hat systems) - - mod_rewrite and mod_headers enabled - - GD libary (for Image plugin) - - cURL, sockets or stream extension (for Web plugin) - - Gzip compression - +- PHP 5.3.4 or higher +- PCRE 8.02 or higher (usually shipped with PHP package, but needs to be additionally updated on CentOS or Red Hat systems) +- mod_rewrite and mod_headers enabled +- GD libary (for Image plugin) +- cURL, sockets or stream extension (for Web plugin) +- Gzip compression + > Nginx and Lighttpd configurations are also possible. http://fatfreeframework.com/system-requirements + #### Database - - mysql: MySQL 5.x - - sqlite: SQLite 3 and SQLite 2 - - pgsql: PostgreSQL - - sqlsrv: Microsoft SQL Server / SQL Azure - - mssql, dblib, sybase: FreeTDS / Microsoft SQL Server / Sybase - - odbc: ODBC v3 - - oci: Oracle +- mysql: MySQL 5.x +- sqlite: SQLite 3 and SQLite 2 +- pgsql: PostgreSQL +- sqlsrv: Microsoft SQL Server / SQL Azure +- mssql, dblib, sybase: FreeTDS / Microsoft SQL Server / Sybase +- odbc: ODBC v3 +- oci: Oracle >Here is a list of links to DSN connection details for all currently supported engines in the SQL layer: http://fatfreeframework.com/sql @@ -39,7 +40,7 @@ http://fatfreeframework.com/sql #### Backend (PHP) *PATHFINDER* is pretty easy to configure! If you are not planning "getting your hands dirty" with programming stuff, -you don´t have to change a lot. All configuration files can be found here: +you don´t have to change a lot. All configuration files can be found here: - [config.ini](https://github.com/exodus4d/pathfinder/blob/master/app/config.ini) Main config **(DO NOT CHANGE)** - [pathfinder.ini](https://github.com/exodus4d/pathfinder/blob/master/app/pathfinder.ini) Pathfinder config - [cron.ini](https://github.com/exodus4d/pathfinder/blob/master/app/cron.ini) Cronjob config @@ -54,7 +55,7 @@ There is **no** need to change any javascript configuration, except *Signature n - [system_effect](https://github.com/exodus4d/pathfinder/blob/master/js/app/config/system_effect.js) System effect config **(DO NOT CHANGE)** > If you found any *Signature Names* or other information missing in these files, please create an [Issue](https://github.com/exodus4d/pathfinder/issues) for that! -I´ll try to fix it with the next release. +I´ll try to fix it with the next release. If you still want to change anything in here, make sure to run the `build` process afterwards (see below). ## Development Environment @@ -63,7 +64,7 @@ There are two main *Gulp tasks* that should help you. - `default` task is designed for *"continuous development"* scenario - `production` task is designed for *"production deployment"* scenario -> If you are **not** planning to change the codebase, you don´t have to do the following steps! +> If you are **not** planning to change the codebase, you don´t have to do the following steps! **1. Install [Node.js](https://nodejs.org)(> v.4.0.1) with [npm](https://www.npmjs.com/)** @@ -80,6 +81,7 @@ There are two main *Gulp tasks* that should help you. - init file watcher for \*.js changes - running [jsHint](http://jshint.com/docs/) on file change - copying **raw** *\*.js* files from *./js* to `dist` folder on file change + ``` $ gulp default --tag v0.0.10 ``` @@ -96,9 +98,10 @@ There are two main *Gulp tasks* that should help you. - combine \*.js dependencies - generate \.js `source maps` - copying **compressed** *\*.js* to `dist` folder for production deployment - ``` - $ gulp production --tag v0.0.10 - ``` + +``` +$ gulp production --tag v0.0.10 +``` > The `production` task may take some seconds (30+ seconds)! As a result, you should have all generated \*.js files ready for deployment in the `dist` folder. The unique version `tag` in this path should ensure that `cache busting` is working correct. @@ -116,11 +119,11 @@ in order to build the single \*.css file out of the **raw** \*.scss source files $ compass watch ``` > This will watch all \*.scss files for changes and generate a compressed \*.css file (./public/css/pathfinder.css). -Don´t worry about `cache busting`. Your current version `tag` will be added to the final path (e.g. ./public/css/pathfinder.css?v.0.0.10) +Don´t worry about `cache busting`. Your current version `tag` will be added to the final path (e.g. ./public/css/pathfinder.css?v.0.0.10) ## SQL Schema To get *PATHFINDER* to work, you will need (at least) **two** databases. The first one is the [SDE](https://developers.eveonline.com/resource/static-data-export) -from *CCP*. The second database is *PATHFINDERS*´s own DB. Make sure, you have the correct DB export for your version! +from *CCP*. The second database is *PATHFINDERS*´s own DB. Make sure, you have the correct DB export for your version! **1. *CCP* Static Data Export ([SDE](https://developers.eveonline.com/resource/static-data-export))** @@ -131,14 +134,14 @@ You need to import the Eve SDE into the database specified in the `DB_CCP_*` set cd mysql-{}/ mysql -u -p __DATABASE_NAME__ < db_file.sql ``` -> If you need an older versions of the SDE, check out[**Fuzzwork**](https://www.fuzzwork.co.uk/dump/)´s awesome dumps! +> If you need an older versions of the SDE, check out[**Fuzzwork**](https://www.fuzzwork.co.uk/dump/)´s awesome dumps! **2. *PATHFINDER* Clean Data Export ([CDE](https://www.google.de))** > Make sure, that all column `indexes` and foreign `key constraints` have been imported correct! Otherwise you will get DB errors and the cache engine can not track all tables (Models), which may result in bad performance! ## Cronjob configuration -*PATHFINDER* requires some dynamic `system data` from *CCP*´s [XML APIv2](http://wiki.eve-id.net/APIv2_Page_Index). +*PATHFINDER* requires some dynamic `system data` from *CCP*´s [XML APIv2](http://wiki.eve-id.net/APIv2_Page_Index). This data is automatically imported by a [*Cron-Job*](https://en.wikipedia.org/wiki/Cron) into the DB. Moreover, there are some predefined *Cron-Jobs* that handle some `db maintenance` and clean up tasks. @@ -146,13 +149,14 @@ Moreover, there are some predefined *Cron-Jobs* that handle some `db maintenance You have to setup a **single** *Cron-Jobs* for this, that handles **all** other *Cron-Jobs* and works as a "*dispatcher*". - **Important**: Block access to `[YOUR INSTALLATION]/cron` (e.g. by `.htaccess` or edit `cron.ini`) - Trigger `[YOUR INSTALLATION]/cron` by [*CLI*](http://php.net/manual/en/features.commandline.php) **every minute**, e.g create `cron.phpx`: - ``` php - exec('wget -qO- /dev/null [YOUR INSTALLATION]/cron &> /dev/null', $out, $result); - echo "start:"; - echo "Returncode: " .$result ."
"; - echo "Ausgabe des Scripts: " ."
"; - echo "
"; print_r($out);
- ```
+
+``` php
+exec('wget -qO- /dev/null [YOUR INSTALLATION]/cron &> /dev/null', $out, $result);
+echo "start:";
+echo "Returncode: " .$result ."
"; +echo "Ausgabe des Scripts: " ."
"; +echo "
"; print_r($out);
+```
  - ... or use [*CURL*](http://php.net/manual/en/book.curl.php) for this ;)
 
 ## Project structure
@@ -176,7 +180,7 @@ You have to setup a **single** *Cron-Jobs* for this, that handles **all** other
       |-- app.js            --> require.js config (!required for production!)
   |-- (0777) logs           --> log files
       |-- ...
-  | -- node_modules         --> node.js modules (not used for production) [check "Development Environment" section]
+  | -- node_modules         --> node.js modules (not used for production) [check "Development Environment"]
       |-- ...
   |-- (0755) public         --> frontend source
       |-- css               --> CSS dist/build folder (minified)
@@ -202,7 +206,7 @@ You have to setup a **single** *Cron-Jobs* for this, that handles **all** other
 ```
 
 ## Thanks!
-I´m very proud that **you** are using *PATHFINDER*!
+I´m very proud that **you** are using *PATHFINDER*!
 
 It took me month of time in development until this project got into the first *BETA*. If you like it, please help to improve it.
-(report bugs, find security issues,...)
\ No newline at end of file
+(report bugs, find security issues,...)