search

emcrisostomo / fswatch

A cross-platform file change monitor with multiple backends: Apple OS X File System Events, *BSD kqueue, Solaris/Illumos File Events Notification, Linux inotify, Microsoft Windows and a stat()-based backend.
https://emcrisostomo.github.io/fswatch/
GNU General Public License v3.0
4.98k stars 327 forks source link

beautiful project home page #36

Open josephholsten opened 9 years ago

josephholsten commented 9 years ago

I'm wanting to link to fswatch from a project of mine: https://github.com/discoteq/discoteq.rb

It would be really nice to have a beautiful home page for fswatch, or at least a rendered version of the man page.

emcrisostomo commented 9 years ago

Yeah, that's one thing I've already looked into because I think it deserves it, too.

fsw at least has a page (although automatic, rendering part of the README file).

I'll try to involve @alandipert on this one: since I'm the only active contributor to fswatch, and since GitHub does not allow repository owners to delegate these privileges to contributors, I'd ask @alandipert to transfer the ownership of fswatch to me (at least temporarily) in order to be able to do it.

What do you think, @alandipert?

alandipert commented 9 years ago

I'm down for anything, but I'm not clear on the privileges we're talking about or what I'm being asked to do. Are we talking about a *.github.io web presence? Is it move the repo to @emcrisostomo's account?

I'm happy to do that, but it if I understand correctly that would mean the project's primary URL would change after having been the same for many years, which could cause people and tools trouble and is something to consider.

If it is establishing a web presence we're talking about here, there are ways to do this that don't involve changing the project sourcecode URL which it might make sense for us to explore.

Again, happy to do anything, just wanted to throw out my concern for consideration.

emcrisostomo commented 9 years ago

Hi @alandipert,

Yes, I was suggesting having a GitHub Pages presence, at least initially since I'm not a web-developer-kind-of-guy and I vote for something with a high coolness/effort ratio. As far as I know only the repo owner can create the GitHub Pages website for a repository and that's why I suggested you moved the repo to my account so that I could start with the auto-generated website and customise from there. If you're aware of other ways to do it and/or if anybody has other suggestions let's discuss them.

As far as repo URLs are concerned, that's a valid point, and in fact forks would be affected because remote URLs should be updated. However, GitHub states that both old web links and git clone, fetch and push operations would be redirected to the new URL (see last section of How to transfer a repository) so it seems we wouldn't break them.

Cheers, -- Enrico

emcrisostomo commented 9 years ago

Hi Alan and all,

I’ve seen you transferred the repository, thanks. I’m releasing 1.4.0 and starting to build a website and the Wiki (in no particular order).

Cheers, --  Enrico Maria Crisostomo

From: Alan Dipert notifications@github.com Reply: alandipert/fswatch reply@reply.github.com> Date: 5 Aug 2014 at 16:31:51 To: alandipert/fswatch fswatch@noreply.github.com> Cc: Enrico Maria Crisostomo enrico.m.crisostomo@gmail.com> Subject:  Re: [fswatch] beautiful project home page (#36)

I'm down for anything, but I'm not clear on the privileges we're talking about or what I'm being asked to do. Are we talking about a *.github.io web presence? Is it move the repo to @emcrisostomo's account?

I'm happy to do that, but it if I understand correctly that would mean the project's primary URL would change after having been the same for many years, which could cause people and tools trouble and is something to consider.

If it is establishing a web presence we're talking about here, there are ways to do this that don't involve changing the project sourcecode URL which it might make sense for us to explore.

Again, happy to do anything, just wanted to throw out my concern for consideration.

— Reply to this email directly or view it on GitHub.

jsarenik commented 8 years ago

Is this done already? http://emcrisostomo.github.io/fswatch/

emcrisostomo commented 8 years ago

Hi @jsarenik,

As you suspect, it is not, that's why this issue is still open. I'm short of time lately.

jsarenik commented 8 years ago

Hi @emcrisostomo, Is there anything I can help you with?

emcrisostomo commented 8 years ago

Hi @jsarenik,

Any idea and/or design and/or code is welcome! The page could use any help I guess since it's pretty basic: the standard GitHub template showing an excerpt of the README.md.