Reading List

This repository contains my open source reading list. See the online version.

My reading list is indeed lacking. Suggestions welcome.

I'm also not a web developer and am happy for feedback on the code/design.

-Brandon.

Goals

• Plaintext and friendly data format.
• Minimal hosting and deployment overhead.
• Offline editing support.

Technologies Used

• Linux and OSX. Windows should also work with Cygwin, but I haven't tried. Please file any issues related to this.
• YAML data.
• GitHub Pages hosts and automatically deploys a 100% client-side website that can also be edited offline. Bower manages 3rd party library dependencies used on the site, stored in bower.json.

Creating Your Reading List: Quick Start

1. Fork or copy the contents of this repository into a new GitHub repository. Make sure the default branch is set to gh-pages for deployment. At this point, you should be able to see my site hosted at. http://<your-github-name>.github.io/reading-list
2. Update the data and personalize index.html. Push your changes to GitHub to see them immediately on the new site.

Local Deployment

Most browsers will not be able to open index.html directly from the filesystem because the js loads YAML resources. One workaround is to use start a simple Python static web server with python2 -m SimpleHTTPServer and access the website with localhost:8000.

Updating Bower Dependencies

Run bower update to obtain the dependencies in bower_components. Run ./update-vendor-deps.sh to copy the necessary portions into vendor.

Inspiration

The following projects inspired me to create a GitHub-hosted reading list.

Generated on 2014-11-02, see the Markdown source of this file for more details.

Credits and Licensing

All portions are MIT licensed by Brandon Amos unless otherwise noted.

This project uses and modifies the following open source projects and resources. Modifications remain under the original license.