Skip to content

Commit

Permalink
readme fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
bak11004 committed Apr 10, 2016
1 parent c134b79 commit d43a402
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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):
Expand Down

0 comments on commit d43a402

Please sign in to comment.