search

cameron / squirt

Speed read the web.
http://www.squirt.io
Apache License 2.0
1.22k stars 206 forks source link

Add contributing details #106

Open mihai opened 10 years ago

mihai commented 10 years ago

Thought of adding some details on setting local development for the project and also updated the CONTRIBUTORS file to link to GitHub profile pages.

Let me know if it looks good.

cameron commented 10 years ago

This looks great, with one little thorn: it breaks my development workflow for www.squirt.io. That repo is setup to serve squirt from a folder called bm. The easiest solution for me would be to put squirt.js back into a folder called bm, but that feels a little silly for everyone else. git subtree split looks promising (I'm already using git subtree to manage the relationship between squirt.io and squirt) because it would allow me to commingle the squirt repo files alongside squirt.io files without isolating them in a sub directory, but if you have any other bright ideas, holler!

mihai commented 10 years ago

git subtree does seem like a solution for this case.

cameron commented 10 years ago

AFAICT, subtree only operates on subdirectories. I need to setup a non gh-pages host to add SSL anyway, so I'll be able to configure nginx to redirect requests for /squirt to /bm/squirt. Will merge as soon as I have my development workflow ironed out (today).

mihai commented 10 years ago

Sounds great, thanks @cameron!

cameron commented 10 years ago

Apologies for the delay here. My attention for the past few days has been primarily on my job, and figuring out how to move http://squirt.io towards a sustainable business. Oh! Just had an idea to fix the dev workflow and merge this!

dsernst commented 10 years ago

Thanks for the local dev tips, @mihai :smiley: