diff --git a/Gemfile.lock b/Gemfile.lock new file mode 100644 index 0000000..25f65b4 --- /dev/null +++ b/Gemfile.lock @@ -0,0 +1,30 @@ +GEM + remote: https://rubygems.org/ + specs: + classifier (1.3.3) + fast-stemmer (>= 1.0.0) + directory_watcher (1.5.1) + fast-stemmer (1.0.2) + jekyll (0.12.1) + classifier (~> 1.3) + directory_watcher (~> 1.1) + kramdown (~> 0.14) + liquid (~> 2.3) + maruku (~> 0.5) + pygments.rb (~> 0.3.2) + kramdown (0.14.2) + liquid (2.5.0) + maruku (0.6.1) + syntax (>= 1.0.0) + posix-spawn (0.3.6) + pygments.rb (0.3.7) + posix-spawn (~> 0.3.6) + yajl-ruby (~> 1.1.0) + syntax (1.0.0) + yajl-ruby (1.1.0) + +PLATFORMS + ruby + +DEPENDENCIES + jekyll diff --git a/README.md b/README.md index f9d344f..47a4cef 100644 --- a/README.md +++ b/README.md @@ -38,26 +38,8 @@ review the content before we post it live. # Run It On Your Machine -``` -git clone https://github.com/github/choosealicense.com -cd choosealicense.com -``` - -The site uses relative links so you can easily click on documents to view -them, though default documents (index.html) won't work. - -Or you can also use a simple local webserver: - - -``` -python -m SimpleHTTPServer -open http://localhost:8000/ -``` - -or if you have IIS Express on Windows - -``` -CD "c:\Program Files (x86)\IIS Express\" -iisexpress /path:c:\path\to\choosealicense.com /port:8000 -open http://localhost:8000/ -``` \ No newline at end of file +1. `git clone https://github.com/github/choosealicense.com` +2. `cd choosealicense.com` +3. `script/bootstrap` +4. `script/server` +5. Open [localhost:4000](http://localhost:4000) in your favorite browser diff --git a/gemfile b/gemfile new file mode 100644 index 0000000..a118dde --- /dev/null +++ b/gemfile @@ -0,0 +1,3 @@ +source 'https://rubygems.org' + +gem "jekyll" \ No newline at end of file diff --git a/script/bootstrap b/script/bootstrap new file mode 100755 index 0000000..d825802 --- /dev/null +++ b/script/bootstrap @@ -0,0 +1,9 @@ +#!/bin/sh + +set -e + +echo "bundling installin'" +bundle install + +echo +echo "You're all set. Just run script/server and you can play license roulette!" \ No newline at end of file diff --git a/script/server b/script/server new file mode 100755 index 0000000..dc8e58e --- /dev/null +++ b/script/server @@ -0,0 +1,5 @@ +#!/bin/sh + +set -e + +bundle exec jekyll --server \ No newline at end of file