Permalink
Browse files

Added how to build and start of contribution guidelines

  • Loading branch information...
1 parent 9c8b318 commit 04f32eae43a5ca812372d61c9475fd27b9715684 @danielmarbach danielmarbach committed Dec 29, 2013
Showing with 64 additions and 0 deletions.
  1. +7 −0 CONTRIBUTING.md
  2. +57 −0 HOW_TO_BUILD.md
View
@@ -0,0 +1,7 @@
+# How to Contribute
+
+First of all, thank you for wanting to contribute to Machine.Specifications! We really appreciate all the awesome support we get from our community. We want to keep it as easy as possible for you to contribute changes that make Machine.Specifications better for you. There are a few guidelines that we need contributors to follow so that we can all work together happily.
+
+## Preparation
+
+Before starting work on a new bug, feature, etc. ensure that an [issue](https://github.com/machine/machine.specifications/issues) has been raised. Indicate your intention to work on the issue by writing a comment against it. This will prevent duplication of effort. If the issue is a new feature, it's usually best to propose a design in the issue comments.
View
@@ -0,0 +1,57 @@
+# How to build
+
+These instructions are *only* for building with Rake, which includes compilation, test execution and packaging. This is the simplest way to build.
+
+You can also build the solution using Visual Studio 2012 or later.
+
+*Don't be put off by the prerequisites!* It only takes a few minutes to set them up and only needs to be done once. If you haven't used [Rake](http://rake.rubyforge.org/ "RAKE -- Ruby Make") before then you're in for a real treat!
+
+At the time of writing the build is only confirmed to work on Windows using the Microsoft .NET framework.
+
+## Prerequisites
+
+1. Ensure you have .NET framework 3.5 and 4.0/4.5 installed.
+
+1. Install Ruby 2.0.0 or later.
+
+ For Windows we recommend using [RubyInstaller](http://rubyinstaller.org/) and selecting 'Add Ruby executables to your PATH' when prompted. For alternatives see the [Ruby download page](http://www.ruby-lang.org/en/downloads/). Be sure to use the 32 bit version.
+
+1. Install Ruby DevKit for 2.0.0 or later.
+
+ For Windows we recommend using [RubyInstaller](http://rubyinstaller.org/), follow the instructions for [DevKit](https://github.com/oneclick/rubyinstaller/wiki/Development-Kit) . For alternatives see the [Ruby download page](http://www.ruby-lang.org/en/downloads/). Be sure to use the 32 bit version.
+
+1. Using a command prompt, install bundler:
+
+ `gem install bundler`
+
+1. Install/update necessary build tools, navigate to your clone root folder and execute:
+
+ `bundle install`
+
+## Building
+
+Using a command prompt, navigate to your clone root folder and execute:
+
+`rake`
+
+or use the provided build batch files.
+
+This executes the default build tasks. After the build has completed, the build artifacts will be located in `Build`.
+
+## Extras
+
+* View the full list of build tasks:
+
+ `rake -T`
+
+* Run a specific task:
+
+ `rake spec`
+
+* Run multiple tasks:
+
+ `rake spec pack`
+
+* View the full list of rake options:
+
+ `rake -h`

0 comments on commit 04f32ea

Please sign in to comment.