From: Michael Hanke Date: Mon, 31 Dec 2012 09:53:10 +0000 (+0100) Subject: Refactor setup instructions and create per package install instructions page. X-Git-Url: https://git.donarmstrong.com/?a=commitdiff_plain;h=be409bf8567f0215613d6a25f33c6b7941864bf3;p=neurodebian.git Refactor setup instructions and create per package install instructions page. --- diff --git a/sphinx/index.rst b/sphinx/index.rst index 55494d2..ed4a6c4 100644 --- a/sphinx/index.rst +++ b/sphinx/index.rst @@ -43,120 +43,7 @@ Learn more about NeuroDebian, the goals of this project, and help us |spread|! Get NeuroDebian =============== -First select what kind of operating system you are using, and then choose a -download server close to you: - -.. include:: sources_lists - -.. raw:: html - -
- This form requires javascript. If disabled, incomplete instructions are - displayed below
-
-
- Instructions for Debian-derived systems -
-

Select desired components:
- - - - - -
only software with guaranteed freedoms
- all packages are - DSFG-compliant, - with permission to use, modify, re-distribute under any condition
all software
- - individual packages may have restrictive licenses and you are required to - check license-compliance manually -
-

- -You can enable NeuroDebian on your system by simply copying and pasting the -following two commands into a terminal window. This will add the NeuroDebian -repository to your native package management system, and you will be able to -install neuroscience software the same way as any other package. - -.. raw:: html - - 
-  After selecting a release the setup code will be shown here.
-
- -Now you can update the package index and you are ready to install packages. -Of course you can use your favorite package manager (e.g. synaptic, adept) -for this. In the terminal you can use :command:`apt-get`:: - - sudo apt-get update - sudo apt-get install mricron - -You are ready to go -- enjoy NeuroDebian! - -.. note:: - - Not every package is available for all distributions/releases. For information - about which package version is available for which release and architecture, - please have a look at the corresponding package pages. - -.. raw:: html - -
-
- -
-
- Instructions for non-Debian systems -
- -For all non-Debian operating systems we recommend to deploy NeuroDebian as a -`virtual appliance`_ (virtual machine) -- this will only take a few minutes. -On all modern hardware (built within -the last 3-4 years) a virtual appliance is a convenient solution to run -NeuroDebian simultaneously with the primary operating system -- without -noticeable performance loss. To start using NeuroDebian: - -1. Download this image file: - -.. raw:: html - - - -2. Import this image into VirtualBox_. If you do not have VirtualBox_ - installed yet, visit the `VirtualBox download page - `_ and get an installer for your - system (installers for Windows, Linux, Mac and Solaris are available). - -3. Finish the configuration by following :ref:`the instructions on setting up - the virtual appliance `. `[Virtual machine - setup video tutorial] `_ - - - - -You are ready to go -- enjoy NeuroDebian! - -.. note:: - - If you still running an older VirtualBox 3.x, download one of the image files - listed below. These older releases are distributed as a `zip` file. Please - extract all files from the `.zip` file, using appropriate software - for your operating system. - - * `NeuroDebian 6.0.2 image (32bit) - `_ [~545MB] - - * `NeuroDebian 6.0.2 image (64bit) - `_ [~560MB] - -.. raw:: html - -
- -.. _virtual appliance: http://en.wikipedia.org/wiki/Virtual_appliance -.. _VirtualBox: http://www.virtualbox.org +.. include:: reposetup.rst .. _news: @@ -301,77 +188,4 @@ News $(buttonid).html("↓↓↓"); }; - function createvmdownload(rel, mir) { - var img_version = '6.0.5'; - var img_suffix; - var base_url; - var img_url; - var md5sum_url; - if (rel == 'win32') { - img_suffix = 'i386'; - } else { - img_suffix = 'amd64'; - }; - if(mir in mirrors) { - base_url = mirrors[mir] + '/vm/'; - img_url = base_url + 'NeuroDebian_' + img_version + '_' + img_suffix + '.ova'; - md5sum_url = base_url + 'MD5SUMS'; - } else { - return 'Internal error'; - }; - return '
Virtual applicance image [MD5SUM, MD5SUM.gpg]
' ; - - }; - - function createrepourl(rel, mir, comp) { - if(mir in mirrors) { - var retrepo = "wget -O- http://neuro.debian.net/lists/" + rel + "." - + mir + "." + comp + " | sudo tee /etc/apt/sources.list.d/neurodebian.sources.list\n" - + "sudo apt-key adv --recv-keys --keyserver pgp.mit.edu 2649A5A9\n"; - return retrepo; - } - - }; - - function update_by_form() { - var rel = $("#release").val(); - var mir = $("#mirror").val(); - var comp = $('input[name="components"]:checked').val(); - if (rel != '' && mir != '') { - if (rel in {'win32':'', 'win64':'', 'mac':''}) { - $('#vmimagedownload').html(createvmdownload(rel, mir)); - $('#vmsetup').slideDown(); - $('#repoconfig').slideUp(); - } else { - $('#vmsetup').slideUp(); - $('#repoconfig').slideDown(); - if (comp == undefined) { - $('#reposetup').slideUp(); - } else { - $('#code').text(createrepourl(rel, mir, comp)); - $('#reposetup').slideDown(); - } - }; - } - else - { - $('#repoconfig').slideUp(); - $('#vmsetup').slideUp(); - }; - }; - - $(document).ready(function($) { - update_by_form(); - $('#repoconfig').hide() - $('#reposetup').hide(); - $('#vmsetup').hide() - $('#release').change(update_by_form); - $('#mirror').change(update_by_form); - $('input[name=components]:radio').change(update_by_form); - }); - diff --git a/sphinx/install_pkg.rst b/sphinx/install_pkg.rst new file mode 100644 index 0000000..699b961 --- /dev/null +++ b/sphinx/install_pkg.rst @@ -0,0 +1,26 @@ +Install a package +================= + +Step 1 +------ + +*[skip this steps if your machine is already configured to use this repository]* + +.. include:: reposetup.rst + +Step 2 +------ + +To install the ``###pkgname###`` package on your system or virtual machine, +open a terminal and execute the following command:: + + sudo apt-get install ###pkgname### + +.. raw:: html + + diff --git a/sphinx/reposetup.rst b/sphinx/reposetup.rst new file mode 100644 index 0000000..f4ebaa5 --- /dev/null +++ b/sphinx/reposetup.rst @@ -0,0 +1,190 @@ +First select what kind of operating system you are using, and then choose a +download server close to you: + +.. include:: sources_lists + +.. raw:: html + +
+ This form requires javascript. If disabled, incomplete instructions are + displayed below
+
+
+ Instructions for Debian-derived systems +
+

Select desired components:
+ + + + + +
only software with guaranteed freedoms
+ all packages are + DSFG-compliant, + with permission to use, modify, re-distribute under any condition
all software
+ + individual packages may have restrictive licenses and you are required to + check license-compliance manually +
+

+ +You can enable NeuroDebian on your system by simply copying and pasting the +following two commands into a terminal window. This will add the NeuroDebian +repository to your native package management system, and you will be able to +install neuroscience software the same way as any other package. + +.. raw:: html + + 
+  After selecting a release the setup code will be shown here.
+
+ +Now you can update the package index and you are ready to install packages. +Simply execute the following command in a terminal:: + + sudo apt-get update + +You are ready to go -- enjoy NeuroDebian! + +.. note:: + + Not every package is available for all distributions/releases. For information + about which package version is available for which release and architecture, + please have a look at the corresponding package pages. + +.. raw:: html + +
+
+ +
+
+ Instructions for non-Debian systems +
+ +For all non-Debian operating systems we recommend to deploy NeuroDebian as a +`virtual appliance`_ (virtual machine) -- this will only take a few minutes. +On all modern hardware (built within +the last 3-4 years) a virtual appliance is a convenient solution to run +NeuroDebian simultaneously with the primary operating system -- without +noticeable performance loss. To start using NeuroDebian: + +1. Download this image file: + +.. raw:: html + + + +2. Import this image into VirtualBox_. If you do not have VirtualBox_ + installed yet, visit the `VirtualBox download page + `_ and get an installer for your + system (installers for Windows, Linux, Mac and Solaris are available). + +3. Finish the configuration by following :ref:`the instructions on setting up + the virtual appliance `. `[Virtual machine + setup video tutorial] `_ + + + + +You are ready to go -- enjoy NeuroDebian! + +.. note:: + + If you still running an older VirtualBox 3.x, download one of the image files + listed below. These older releases are distributed as a `zip` file. Please + extract all files from the `.zip` file, using appropriate software + for your operating system. + + * `NeuroDebian 6.0.2 image (32bit) + `_ [~545MB] + + * `NeuroDebian 6.0.2 image (64bit) + `_ [~560MB] + +.. raw:: html + +
+ +.. _virtual appliance: http://en.wikipedia.org/wiki/Virtual_appliance +.. _VirtualBox: http://www.virtualbox.org + +.. raw:: html + +