From d43a402e1f505b307fc994046cdabf3d2b34feeb Mon Sep 17 00:00:00 2001 From: Brian Kelleher Date: Sun, 10 Apr 2016 09:44:03 -0400 Subject: [PATCH] readme fixes --- README.md | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f08c354..6a706c0 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ vagrant box add ubuntu/trusty64 vagrant up ``` -The above will create a local site at [http://192.168.33.60](http://192.168.33.60/) that points to the `www` folder. +The above will create a local site at [http://ation.local](http://ation.local/) that points to the `www` folder. ## Development @@ -26,6 +26,29 @@ npm install Then use `gulp` to develop, it watches the `src/images/`, `src/styles/`, and `src/scripts/` folders and compiles their production version to the `static/` directory. +## Navigating the Code + +This site is based off the Timber (Twig x Wordpress) library. It seems a bit daunting at first but it is significantly easier than writing native Wordpress code into theme files. Any questions about Timber functionality can be answered in their [docs](http://timber.github.io/timber/#getting-started) or in their (github wiki)[https://github.com/timber/timber/wiki]. + +Our relevant project structure is as follows: + +``` +/ationframework + /www + /wp-env # Holds environment specific wordpress variables (db) + /wp-content + /themes + /ation2016 # Holds all relevant theme files + /page.php # All logic for pages held here + /functions.php # Theme specific options, video shortcode, script loading + /package.json # Holds information for npm dependencies + /gulpfile.js # Holds information for gulp build tasks + /src # Asset images, styles, scripts for development + /static # Everything from /src gets compiled here for production + /templates # All twig page templates and partials + /views # Additional pluggable partials +``` + ## Syncing Media From local machine to remote (replacing SSHALIAS with your ssh alias or user@host):