Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve installation instructions #70

Merged
merged 14 commits into from
Jul 23, 2019
Merged

Improve installation instructions #70

merged 14 commits into from
Jul 23, 2019

Conversation

adswa
Copy link
Contributor

@adswa adswa commented Jul 17, 2019

  • Start more general with the installation; note that python, pip, git, git-annex and datalad are different components
  • More verbosity on existing instructions; info on how to install homebrew or do a pip install --user
  • Restructure hierarchy: start with Linux, then OSX, pip, Windows
  • add installation instruction for Windows without and with WSL2. I've only tested this on a very old computer and it seems to work, but there are no guarantees for anything. In any way, its better to have something than nothing, I suppose. What is an absolute life-saver is Neurodebian.

Still-TODOs:

  • How to install Git-annex without administrative power
  • mabye tell everyone who is not on Windows 10 that thats a problem?

@adswa
Copy link
Contributor Author

adswa commented Jul 17, 2019

(Note that there is a keyserver issue on WSL which I'm trying to mitigate by having users curl and apt-key add the Neurodebian repository key)

@adswa
Copy link
Contributor Author

adswa commented Jul 17, 2019

Todays' discussion showed that we should try it out on WSL2 and provide installation instructions for this as well. From my point of view, there are improvements in this PR to the general feel and content of the installation instruction, and even though Windows installation instructions are yet incomplete, its better than having none.

docs/basics/installation.rst Outdated Show resolved Hide resolved
docs/basics/installation.rst Outdated Show resolved Hide resolved
docs/basics/installation.rst Outdated Show resolved Hide resolved
docs/basics/installation.rst Outdated Show resolved Hide resolved
docs/basics/installation.rst Outdated Show resolved Hide resolved
docs/basics/installation.rst Outdated Show resolved Hide resolved
docs/basics/installation.rst Outdated Show resolved Hide resolved

If you have always used Windows be prepared for some user experience changes when
using Linux compared to Windows. For one, there will be no graphical user interface
(GUI). Instead, you will work inside of the standard Linux terminal. This however
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sounds scary, but it only refers to the terminal window with datalad inside, no?

docs/basics/installation.rst Outdated Show resolved Hide resolved
docs/basics/installation.rst Outdated Show resolved Hide resolved
@adswa
Copy link
Contributor Author

adswa commented Jul 18, 2019

Thx, @mih!

@mih
Copy link
Collaborator

mih commented Jul 23, 2019

Pushed minor changes and merged master to get into mergeable state. Ready to go once tests have passed.

@adswa
Copy link
Contributor Author

adswa commented Jul 23, 2019

Nice, thx!

@adswa adswa merged commit 44018a1 into master Jul 23, 2019
@adswa adswa deleted the install branch July 23, 2019 07:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants