trogdoro / xiki

A shell console with GUI features
http://xiki.org
Other
3.76k stars 207 forks source link

Install from GitHub instructions incorrect #30

Closed evanrelf closed 11 years ago

evanrelf commented 11 years ago

The install instructions for cloning from GitHub are currently like this:

$ git clone git@github.com:trogdoro/xiki.git
$ cd xiki
$ sudo gem install bundler
$ sudo bundle install --system
$ sudo ruby etc/command/copy_xiki_command_to.rb /usr/local/bin/xiki

...however, the first line prompts for an SSH key. In order for others to be able to clone the repo, the first line should be changed to:

$ git clone https://github.com/trogdoro/xiki.git
kotp commented 11 years ago

Not incorrect, as both ways are correct.

The second way would be a solution for someone that doesn't have a github.com account.

evanrelf commented 11 years ago

Sorry for my misunderstanding.

kotp commented 11 years ago

Perhaps both need to be presented... one for those that may not have a github and have only installed it for installing different things. Would you like to clone it, make a patch for the documentation? I have a feeling the documentation always will need some work. Worst thing that can happen is Craig doesn't pull it, or it gets modified.

evanrelf commented 11 years ago

As far as I can tell, the change I made in my original comment works for everyone, including people not signed up for GitHub. I'll try forking it.

trogdoro commented 11 years ago

Fixed in https://github.com/trogdoro/xiki/commit/468ead70a74756f61b5385a3c3bb68e9724a56ee

kotp commented 11 years ago

@evanrelf of course it does. You don't need to fork it. Sorry, didn't mean to cause any confusion. It is a good change. It lets us that know git use the ssh link, and those that don't simply not worry about it.