Read Me for Student Radio Theme

<div class="readme file wiki-content">
              
                <h1 id="markdown-header-student-radio-association-wordpress-installation">Student Radio Association Wordpress Installation</h1>
<p>Welcome! This is the repo for all the custom scripting of the Student Radio Association's website (Version 3 "Wordpress").</p>
<h3 id="markdown-header-history">History</h3>
<p>The <a href="http://www.studentradio.org.uk">SRA</a> started development of this project with Jason Slack (then Web Officer) building the initial template in 2013. Development halted for a period at the end of 2013. This was then picked up again by Fred Bradley, adapting Jason's original theme to bring it more inline with core Wordpress functionality and adding some new development practices to help aide faster progress.</p>
<h3 id="markdown-header-development-principles">Development Principles</h3>
<h4 id="markdown-header-the-basic-rules">The Basic Rules</h4>
<ol>
<li>Comment as much as possible, so your gran could understand what the code does!</li>
<li>Limit third party code features, so your site does not rely another person's development cycle!</li>
<li>Build to latest standards. Although the goal posts are always changing, we aim to deliver a comprehensive site that works for the SRA rather than just 'is for the SRA'.</li>
<li>Be inspired. We, in turn, are inspired by <a href="http://www.bbc.co.uk/blogs/legacy/bbcinternet/2009/03/ten_publishing_principles_for.html">other people's principles</a>.</li>
</ol>
<h4 id="markdown-header-sass">SASS</h4>
<p>This project uses <a href="http://sass-lang.com/guide">SASS</a> (.scss type) please don't try and edit the .css files directly!</p>
<p>The default Wordpress <strong>style.css</strong> is blank (apart from the obligatory Wordpress Comments)</p>
<p>The theme's main style is editable at <strong>themes/studentradio/association/scss/style.scss</strong> which is then compiled to <strong>themes/studentradio/association/css/style.css</strong>. (It is enqueued in <strong>functions.php</strong>)</p>
<p>The Shared .scss files are in the <strong>themes/studentradio/shared/css</strong> folder. These are then called (via SASS) in the main theme's css.</p>
<p><em>Please try and keep to this practice as it will help with further development.</em></p>
<p>There are two ways to compile the CSS:</p>
<ol>
<li>
<p>In the command line, navigate to the theme's main root (<strong>themes/studentradio/association</strong>) and call: <code>$ compass compile</code></p>
</li>
<li>
<p>For those less familiar with the command line, I have created a button in the Wordpress admin titled: <strong>Compile CSS</strong>. Simply click that, and if there are any changes to compile, it will do it for you!</p>
</li>
</ol>
<h3 id="markdown-header-help">Help</h3>
<p><a href="http://wordpress.stackexchange.com/questions/26537/between-functions-php-widgets-and-plugins-which-is-loaded-first">Here is a really useful piece of information that tells the order that Wordpress loads items! This has saved my head hurting many times during this development.</a></p>
<h4 id="markdown-header-bugs-feature-requests-issues">Bugs &amp; Feature Requests = Issues</h4>
<p>Please use the <a href="https://bitbucket.org/fredbradley/student-radio-v3/issues">Issues</a> feature built in with this repo. We use it to track progress, manage, and prioritise bugs and enhancements.</p>
<h4 id="markdown-header-via-email">Via EMail</h4>
<p>If you require further help I suggest you contact <a href="http://twitter.com/fredbradley">Fred Bradley</a> first!</p>
<h3 id="markdown-header-developers">Developers</h3>
<h4 id="markdown-header-main-team">Main Team</h4>
<ul>
<li><a href="http://twitter.com/fredbradley">Fred Bradley</a> - expertise in Wordpress Development, PHP, SASS, Schema and APIs</li>
<li><a href="http://twitter.com/OliverNeedham">Oliver Needham</a> - helping with styling to the SRA's spec</li>
<li><a href="http://twitter.com/stumanton">Stu Manton</a> - leading direction for the project</li>
</ul>
<h4 id="markdown-header-honorable-mentions">Honorable Mentions</h4>
<p>All of the below have at some point put in their own free time to help with the project and we are extremely thankful of their support!</p>
<ul>
<li>Jason Slack</li>
<li>Ben Stones</li>
<li>Lee Sevenoaks</li>
<li>Thomas Mees</li>
<li>Matt Hurst</li>
</ul>
            </div>