From f887082bc02710a168a850223ba9aaf9b95c7031 Mon Sep 17 00:00:00 2001 From: Marty Wallace Date: Wed, 11 Mar 2015 12:21:09 +1100 Subject: [PATCH] Version appendage, more README updates. --- README.md | 31 ++++++++++++++++++++++++------ html/tempest/_layout.html | 2 +- server/tempest/Tempest/Tempest.php | 8 ++++++++ 3 files changed, 34 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index c1080bb..151c262 100644 --- a/README.md +++ b/README.md @@ -10,12 +10,18 @@ Tempest makes use of various tools to streamline the development process: * [NodeJS & Node Package Manager](http://nodejs.org/), for managing Grunt tasks. * [Bower](http://bower.io/), for managing front-end JavaScript dependencies. * [Grunt](http://gruntjs.com/), for running Grunt tasks. +* [Ruby](http://rubyinstaller.org/), required by SASS. +* [SASS](http://sass-lang.com/install), for compiling SASS. +* [TypeScript](http://www.typescriptlang.org/#Download), for compiling TypeScript. ## Getting Started. 1. Download and extract the files to your server - `public` should be set as the server root. - * Set up a virtual host; [these instructions](http://sawmac.com/xampp/virtualhosts/) may help beginners. - * Using PHP's [inbuilt server](http://php.net/manual/en/features.commandline.webserver.php) is much easier than the above. + * Set up a virtual host; [these instructions](http://sawmac.com/xampp/virtualhosts/) may help beginners, or; + * Use PHP's [inbuilt server](http://php.net/manual/en/features.commandline.webserver.php). Simply navigate to the application root, then: + + $ php -S localhost:80 -t public + 2. `cd` to your application directory and run the following commands: $ npm install @@ -25,7 +31,14 @@ Tempest makes use of various tools to streamline the development process: ## Development Guide. -#### JavaScript & TypeScript. +### Grunt. + +[Grunt](http://gruntjs.com/) is used to automate the compilation of various files into the public directory (e.g. `/sass` into `/public/css`). There are two grunt tasks available: + +1. `grunt dev` (default) - compiles files without minification and runs a watch task for use during development. +2. `grunt prod` - compiles and minifies files for production use. + +### JavaScript & TypeScript. * Put your JavaScript or TypeScript files into `js/app/`. They will be compiled down into `public/js/app.js`. * For JavaScript dependencies; @@ -34,19 +47,19 @@ Tempest makes use of various tools to streamline the development process: * These will be cocatenated down into `public/js/vendor.js`. * Tempest comes with some JavaScript of its own. It is compiled down into `public/js/tempest.js`. -#### SASS. +### SASS. * Put your SASS into `sass/`. Your SASS will be compiled down into `public/css/`. * Files beginning with `_` will not be compiled, following standard SASS rules. * Some useful boilerplate SASS is located in `sass/vendor/`. -#### HTML & Twig. +### HTML & Twig. * Tempest uses [Twig](http://twig.sensiolabs.org/) for templating. * Put your Twig & HTML files in `html/`. * These files are not manipulated or compiled in any way; Tempest will look in `html/` for Twig templates. -#### Configuration. +### Configuration. * Application configuration is stored in `config.php`. More instructions on configuration are provided at the top of the file. @@ -55,8 +68,14 @@ Tempest makes use of various tools to streamline the development process: * [1.0.0](https://github.com/MartyWallace/Tempest/releases/tag/1.0.0) * Modern project structure (using `public` for public files). * Using Twig for templating. + * Added Grunt for task automation. + * Added SASS & TypeScript compilation. + * Added Bower for JavaScript dependency management. + * Added Composer for PHP dependency management. * Application services. + * Cascading app configuration based on server name. * General cleanup. + * [0.0.1](https://github.com/MartyWallace/Tempest/releases/tag/0.0.1) * This release is explained in the [wiki section](https://github.com/MartyWallace/Tempest/wiki). * Custom logicless templating. diff --git a/html/tempest/_layout.html b/html/tempest/_layout.html index 452fc57..5f02776 100644 --- a/html/tempest/_layout.html +++ b/html/tempest/_layout.html @@ -45,7 +45,7 @@
NAMED
diff --git a/server/tempest/Tempest/Tempest.php b/server/tempest/Tempest/Tempest.php index df5074b..66830c5 100644 --- a/server/tempest/Tempest/Tempest.php +++ b/server/tempest/Tempest/Tempest.php @@ -311,4 +311,12 @@ public function getRouter(){ return $this->router; } */ public function getServices(){ return $this->services; } + + /** + * Returns the current version of Tempest. + * + * @return string + */ + public function getVersion(){ return '1.0.0'; } + } \ No newline at end of file