Skip to content

Latest commit

 

History

History
63 lines (43 loc) · 2.22 KB

README.md

File metadata and controls

63 lines (43 loc) · 2.22 KB
Raw

hackercouch Build Status

HackerCouch is "Hospitality for Hackers". Here's how it goes:

  • Fork this repo
  • Add your own markdown file with your nick (perhaps twitter/github handle?) in the _couches directory
  • You file a Pull Request on github
  • Make sure the build passes
  • Go check hackercouch.com the next time you are travelling.

See add.md for more detailed instructions.

The idea isn't new, it has been tried before as well. The reason we are trying this again is:

  • The idea of a Fork->PR->Merge->Publish flow with almost zero effort
  • Filing a pull request is a great filter for hackers
  • hackercouch.com was available
  • This comment by @sirupsen on HN

Development

  • HackerCouch uses Jekyll Collections heavily
  • Hosted on Github Pages, duh.
  • Builds use Travis, and make sure that the site has proper html before its deployed
  • html-proofer for html linting + link checks

Quickstart

. ./_script/setup-env.sh
gem install bundler
bundle install
jekyll serve --watch

And open http://localhost:4000 in your browser.

Troubleshooting

  • If your bundle fails due Nokogiri and you're on OSX, try running this first: xcode-select --install

Credits

Disclaimer

Our disclaimer policy is here.

LICENSE

This uses Jekyll collections and the base Jekyll theme. The very little code here is licensed under the MIT License. However, everything under the _couches directory is licensed under the CC0 license. If you file a PR to this repo, you agree to having your "couch information" available under this license.

The minimum required information is your nick, city and country code.