Robot documentation and information site
HTML CSS JavaScript
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
common
source
.gitignore
CNAME
Gruntfile.js
LICENSE
README.md
package.json

README.md

Robot Home

Built with Grunt ZLIB Licensed

Hosts the official getrobot.net website encompassing all information related to the Robot project. The repository is separated into three branches: The master branch hosts the current live version of the website, the source branch hosts the source files used to compile the website, and the dev branch hosts the source files currently in development. The files in the master branch should never be modified directly as they get overwritten whenever the website gets recompiled, instead, modify the files in the source branch. To compile the website, follow the instructions below.

Getting Started

Perform the following once per machine install

  • Download and install Node.js onto your system
  • Open a terminal and install the grunt.js client
# Verify Node.js install
node -v

# Install Grunt.js client
npm install -g grunt-cli

Perform the following once per source branch pull

# Navigate to project root
cd path/to/robot.github.io/

# Install the dependencies
npm install

Compiling

To compile the website, make sure you have followed the getting started guide. Once you have installed node, the grunt.js client, and the project dependencies, compiling the website will be fast and simple. First, make sure your terminal window is pointing to the project root directory. Then use the following commands to compile the website:

# Compile the entire website
grunt

# Delete all compiled files
grunt clean

# Auto compile changed files
grunt watch

Contributing

See the contributing guide here.