Skip to content
This repository has been archived by the owner on Apr 9, 2023. It is now read-only.

Latest commit

 

History

History
81 lines (59 loc) · 2.83 KB

GCI.md

File metadata and controls

81 lines (59 loc) · 2.83 KB
Raw

Welcome to Terasology Google Code-in 2017 Showcase site!

This page is created to serve as a tutorial on how to create content for the Google Code-in 2017 showcase page.

Installation

Prerequisites

Mac OSX/Linux

This site is built with jekyll which comes as a ruby gem. So you need to install Ruby to get started.

RVM make it easy to install and manage different versions of Ruby. Install Ruby using RVM by running the following commands

~ $ gpg --keyserver hkp://keys.gnupg.net --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3

~ $ \curl -sSL https://get.rvm.io | bash -s stable --ruby

This installs RVM with the latest stable version of Ruby

Ubuntu users: You may need to enable Run command as a login shell in Ubuntu's Terminal, under Edit > Profile Preferences > Title and Command. Then close the terminal and reopen it. You may also want to run source ~/.rvm/scripts/rvm to load RVM.

To install ruby gems from a Gemfile you would need bundler which by default comes with RVM ruby but if isn't present you would need to install it using the command gem install bundler.

Windows

If on Windows, you can follow this guide on how to install jekyll.

Deployment

After you have installed Ruby and cloned the repository deploy the application running the following commands

# Enter the app directory
~ $ cd movingblocks.github.com

# Install gems using bundler
~/cd movingblocks.github.com $ bundle install

# Build site starting jekyll server
~/cd movingblocks.github.com $ bundle exec jekyll serve

You are ready to go! Browse to http://localhost:4000

Source: FOSSASIA

Adding a mentor

Create a .md file in _mentors, you need to use the following format and fill in the information accordingly.

---
name: Mentor's full name
country: Mentor's country (2 Letter)
timezone: Mentor's timezone
github: Mentor's GitHub username
introduction: >
  Hello! My name is XXX! It's nice to meet you, I hope you enjoy your stay in MovingBlocks :D
  // This is an example introduction
fields:
  - enter your field here
  - enter your field here
---

NOTE

  • You can check your country code and timezone from this Wikipedia page. Country code is written CC and Timezone is TZ

Adding a world generator

Create a .md file in _worldgen, you need to use the following format and fill in the information accordingly.

---
name: World generator's name
author: World generator's author
banner-img: "/img/world-gen-img-goes-here.jpg"
description: >
  World generator description goes here
---

NOTE

  • Add your banner image to folder /img/