Last active
August 29, 2015 14:15
-
-
Save eksperimental/a0079f0012ccac622368 to your computer and use it in GitHub Desktop.
elixir-lang instructions
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
1) **Fork and Clone this Repository** | |
[Fork this repository](https://github.com/elixir-lang/elixir-lang.github.com/fork), and Create a local clone of your fork. You may want to read the [Instructions on how to do that](https://help.github.com/articles/fork-a-repo/). | |
2) **Install [Ruby](https://www.ruby-lang.org/)** | |
To setup a development enviroment locally, you need to have Ruby installed. If you are running a Mac, it's probably installed. Run in your shell `ruby --version`. Your Ruby version should begin with `1.9.3` or `2.0.0`. You can follow [this guide](https://www.ruby-lang.org/en/documentation/installation/) if you need to install it. | |
3) **Install [Bundler](http://bundler.io/)** | |
```bash | |
gem install bundler | |
``` | |
4) **Install Project Dependencies** | |
Once you have Bundler installed, `cd` into the forked project and download and install all the necessary dependencies by running: | |
```bash | |
$ bundle install | |
``` | |
This will install `jekyll` and the `github-pages` package, which will install all the same packages with the same versions that are run in GitHub server, so we can test locally, as if we were [running live](http://elixir-lang.org). | |
5) **Run Jekyll** | |
Run a development server (with live-reloading on) on http://localhost:4000/ | |
```bash | |
$ bundle exec jekyll serve | |
``` | |
6) **Make your Changes and Test Them** | |
Now you're ready to make your changes! Be sure to test the changes locally using | |
the development server. Once you're done with your changes, [push those changes | |
to your fork](https://help.github.com/articles/pushing-to-a-remote/) and then [submit a **pull request**](https://help.github.com/articles/using-pull-requests/). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment