Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add technical set-up information to readme #19

Open
wants to merge 1 commit into
base: gh-pages
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,37 @@ development data and encouraging its use to inform decisions within the
sector.

More information on the [Open development Toolkit](http://opendevtoolkit.net)


## How to contribute

See the [guide](https://github.com/zararah/opendevtoolkit/blob/gh-pages/how-to-contribute.md) for details.


## Technology set-up

The repository is configured to use [Jekyll](https://jekyllrb.com/) to serve pages as a static site. Use of Jeckyll is supported by [GitHub pages](https://pages.github.com/).


## Running a local version

# Clone the repository and navigate into the directory
git clone https://github.com/zararah/opendevtoolkit.git
cd opendevtoolkit

# Set-up jekyll if not already installed (note this requires [RubyGems](https://rubygems.org/pages/download))
gem install jekyll

# Run an on-the-fly development version
jekyll serve

# Open a web browser and navigate to http://127.0.0.1:4000/


## Deploying to a web server

# Download the repository as above, however output the static files rather than serving on the fly
jekyll build

# The static website files will now be in the '_site' directory
# These can be transfered to your server, for example using ftp or scp