This is the repo for the U.S. Federal Web Design Standards project. The structural setup of this repo is based off of the 18F pages project: https://github.com/18F/pages

You will need Ruby ( > version 2.1.5 ). You may consider using a Ruby version manager such as rbenv or rvm to help ensure that Ruby version upgrades don't mean all your gems will need to be rebuilt.

On OS X, you can also use Homebrew to install Ruby in /usr/local/bin, which may require you to update your $PATH environment variable. Here are the commands to follow to install via homebrew:

$ brew update
$ brew install ruby

Now that you have verified that you have Ruby installed, clone and run the following go commands to initialize and serve the library locally.

$ git clone git@github.com:18F/usfwds.git
$ cd usfwds
$ ./go init
$ ./go serve

You should now be able to visit http://127.0.0.1:4000/usfwds/ and view the web design standards locally.

Questions or need help with setup? Feel free to open an issue here https://github.com/18F/usfwds/issues.

This project is in the worldwide public domain. As stated in CONTRIBUTING:

This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.

All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.