Skip to content

Update README.md #288

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

Merged
Merged
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
38 changes: 21 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
Berlin Code of Conduct
======================

This code of conduct is online at: http://rubyberlin.github.io/code-of-conduct/
This code of conduct is online at https://rubyberlin.github.io/code-of-conduct/

Add Your User Group/Conference to the List
------------------------------------------

1. Fork repository.
2. Open *data/supporters.json* and add your name, location,
link and contact data.
2. Open *data/supporters.json* and add your name, location, link and contact data.
3. Check if site is working locally if possible (see [setup](#setup)).
4. Open a pull request.

Expand All @@ -32,24 +31,25 @@ Do you want to translate to another language? Great! If you want to translate fr
3. Open a pull request. We will try to find other native speakers and disscuss it there. The discussion may look like [the one for the Spanish translation](https://github.com/rubyberlin/code-of-conduct/pull/23).



Setup
-----

Ruby 2.x.y (1.9.x still OK) must be [installed](http://www.ruby-lang
.org/de/downloads/).

git clone git@github.com:rubyberlin/code-of-conduct.git
cd code-of-conduct
gem install bundler
bundle
Ruby 2.x.y (1.9.x still OK) must be [installed](http://www.ruby-lang.org/de/downloads/).

```bash
git clone git@github.com:rubyberlin/code-of-conduct.git
cd code-of-conduct
gem install bundler
bundle
```

Development
-----------

cd code-of-conduct
bundle exec middleman
```bash
cd code-of-conduct
bundle exec middleman
```

You can access the website at <http://localhost:4567/>.

Expand All @@ -59,10 +59,14 @@ Deployment

Building the website:

cd code-of-conduct
bundle exec middleman build
```bash
cd code-of-conduct
bundle exec middleman build
```

Deploying to github pages (needs push access to this repository):

cd code-of-conduct
bundle exec middleman deploy
```bash
cd code-of-conduct
bundle exec middleman deploy
```