Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/alisdair/seed-docs

Docs and guidelines for Seed CSS
https://github.com/alisdair/seed-docs

Last synced: 10 days ago
JSON representation

Docs and guidelines for Seed CSS

Awesome Lists containing this project

README

        

# seed-docs [![Build Status](https://travis-ci.org/helpscout/seed-docs.svg?branch=master)](https://travis-ci.org/helpscout/seed-docs) [![Dependency Status](https://david-dm.org/helpscout/seed-docs.svg)](https://david-dm.org/helpscout/seed-docs)
Docs and guidelines for Seed CSS

## Requirements
- Ruby
- Bundler
- Node
- Gulp

##### Ruby
If you do not have Ruby on your system, check out [this guide](https://github.com/rbenv/rbenv) from rbenv.

##### Bundler
Once you have Ruby installed on your machine, run the following command to install [Bundler](http://bundler.io/)
```
gem install bundler
```

##### Node
If you do not have Node installed on your machine, we recommend installing it using [Homebrew](https://github.com/customerio/mvp#homebrew).

Run the following command in your command line:
```
brew install node
```

##### Gulp
Help Scout's styleguide site is compiled using Gulp. See the [Getting Started](https://github.com/gulpjs/gulp/blob/master/docs/getting-started.md) guide for more information.

```
npm install -g gulp-cli
```

## Getting started

Run the following to install all the node things:
```
npm install
```

When you're ready, run the following to fire it up! (P.S. It *should* automatically resolve/install ruby and node things for you)
```
gulp
```