From 6e5bc337e6fedb5584a89e48dd71c9f45310c77a Mon Sep 17 00:00:00 2001 From: Michael Hanke Date: Tue, 22 Jun 2010 18:49:33 -0400 Subject: [PATCH] Rewording, typos --- sphinx/faq.rst | 31 +++++++++++++++--------------- sphinx/index.rst | 49 +++++++++++++++++++++++++---------------------- sphinx/spread.rst | 2 +- 3 files changed, 42 insertions(+), 40 deletions(-) diff --git a/sphinx/faq.rst b/sphinx/faq.rst index 04e2f73..98bce07 100644 --- a/sphinx/faq.rst +++ b/sphinx/faq.rst @@ -17,21 +17,21 @@ Frequently Asked Questions Why NeuroDebian? ---------------- - In the course of our research endeavors |we| have joined the forces to - develop a `PyMVPA -- Python framework for multivariate pattern analysis of - neural data `_. To provide convenient deployment for - anyone using Debian-derived distribution this package repository was - created. Besides PyMVPA_ project |we| collaborate with `NiPy team + In the course of our own research endeavors |we| have joined forces to + develop `PyMVPA -- a Python framework for multivariate pattern analysis of + neural data `_. To conveniently deployment PyMVPA for + anyone using Debian-derived distributions this package repository was created + initially. Besides the PyMVPA_ project |we| collaborate with the `NiPy team `_ on various projects, such as NiBabel_ and - NiPype_. Quickly NeuroDebian_ became our ultimate delivery mechanism for - all the projects we develop and package, so they are readily available for - deployment. + NiPype_. Quickly NeuroDebian_ became the ultimate integrated environment for + all these projects. We are now constantly working on enriching this + environment with as many additional relevant software as possible. Why is NeuroDebian not a Pure Blend? ------------------------------------ - Because there is not need for it to become one, as the existing Debian Pure + Because there is no need for it to become one, as the existing Debian Pure Blends already offer the desired functionality *within* Debian. Similar to Pure Blends, NeuroDebian's goal is to provide software for neuroscientists using the Debian operating system, and therefore the ultimate goal is to get @@ -39,7 +39,7 @@ Why is NeuroDebian not a Pure Blend? However, various reasons exist that prevent a particular software from entering Debian. Some are temporary, i.e. a package is already useable, but - some technical bits do not meet Debian's standard yet or a licensing issue + some technical bits do not meet Debian's standards (yet) or a licensing issue needs to be resolved first. For some software the licensing is so restrictive that it cannot be distributed by Debian, and hence cannot even go into its *non-free* branch. Unfortunately, sometimes these issues cannot be solved to @@ -87,12 +87,11 @@ Debian, Debian, Debian -- What about Ubuntu? it is more efficient to spend time packaging for Debian. After the appearance of new packages in Debian, Ubuntu typically synchronizes them quickly and they become available in the *Ubuntu universe* -- a repository of Debian - packages rebuilt for a particular Ubuntu release. We are not carrying out - rebuilding of all already available in NeuroDebian packages for new Ubuntu - releases. So you might find some packages present solely at NeuroDebian for - older Ubuntu releases being absent from newer releases until the point when - a new Debian version of the package comes out and gets built for all - releases. + packages rebuilt for a particular Ubuntu release. We are not constantly + rebuilding of all available NeuroDebian packages for new Ubuntu + releases. Therefore, you might find some packages only being available + for older Ubuntu releases -- until the point when a new package version is + made and gets built for all currently supported releases. How to create a mirror of the repository? diff --git a/sphinx/index.rst b/sphinx/index.rst index f61cf24..8a023ee 100644 --- a/sphinx/index.rst +++ b/sphinx/index.rst @@ -5,20 +5,17 @@ *********************************************** This repository provides mostly neuroscience-related packages to be used on -Debian systems (or Debian-derivatives like Ubuntu). It contains both unofficial -or prospective packages which are not (yet) available from the main Debian -archive, as well backported or simply rebuilt packages also available +Debian_ systems (or Debian-derivatives like Ubuntu_). It contains both unofficial +or prospective packages which are not (yet) available from the main Debian_ +archive, as well as backported or simply rebuilt packages also available elsewhere. Please see the :ref:`faq` for more information about the goals of this project. This service is provided "as is". There is no guarantee that a package -works as expected, so use them at your own risk. They might kill your -system (although that is rather unlikely). You've been warned! +works as expected, so use them at your own risk. If you encounter problems, +please `report <#contact>`_ them. -The repository contains both neuroscience-related packages, as well as general -purpose software which is necessary to resolve dependencies, or such that is -simply useful in the neuroscience context. All featured neuroscience software -packages are available from the :ref:`full package list `. +Please |spread|, if you like it. .. raw:: html @@ -28,6 +25,7 @@ packages are available from the :ref:`full package list `.

+.. _Ubuntu: http://www.ubuntu.com News ==== @@ -131,8 +129,8 @@ Or you will be asked questions like this over and over:: Install these packages without verification [y/N]? This is because your APT installation initially does not know the GPG -key that is used to sign the release files of this repository. Making -APT happy again is easy: +key that is used to sign the release files of this repository. It is easy to +make APT happy again: 1. Get the key. Either download the `repository key from here <_static/neuro.debian.net.asc>`_ @@ -155,11 +153,14 @@ Installation Virtual Machine --------------- -If your are not running Debian_ on a particular machine a :ref:`chap_vm` is -provided as a convenient testing and evaluation environment. After a -few simple steps to setup the virtual machine, you will be able to use -NeuroDebian_ as an integral part of your existing working -environment without any sacrifice. +If you are not running Debian_ on a particular machine a :ref:`chap_vm` is +provided as a convenient testing and evaluation environment. After a few +simple steps to setup the virtual machine, you will be able to use NeuroDebian_ +as an integral part of your existing working environment without any sacrifice. +The virtual machine is also a suitable environment to temporarily deploy +neuroscience software on machines running other operating systems, e.g. for the +purpose of teaching a neuroimaging data analysis course in a multipurpose +computer lab. Debian @@ -179,10 +180,10 @@ hardware architecture and then simply add |repos|. The Team ======== -Our main goal is to provide neuroscience FOSS for Debian_. Thus the +Our main goal is to provide neuroscience FOSS_ for Debian_. Thus the whole project would not be possible without the work of over 3,000 Debian_ developers and contributors who are as enthusiastically pursuing -a similar goal. To add our share -- Debian_ packages of FOSS for +a similar goal. To add our share -- Debian_ packages of FOSS_ for neuroscience research -- the `Experimental Psychology Debian packaging project `_ was created to formally join the forces of @@ -190,17 +191,19 @@ to formally join the forces of * `Michael Hanke `_ * `Yaroslav Halchenko `_ -A number of packages that are now provided within the NeuroDebian repository +A number of packages that are now available from the NeuroDebian repository were not packaged by our team, but similar Debian teams. Therefore we want to -express particular gratitude to `Debian Med`_ and `Debian Science`_ teams for -all their work. +express particular gratitude to the `Debian Med`_ and `Debian Science`_ teams +for all their work. + +.. _FOSS: http://en.wikipedia.org/wiki/Free_and_open_source_software Contact ======= -`Email us `_ if you have any suggestions or -simply |spread| if you liked it. +`Email us `_ if you have any suggestions or want to +report a problem. .. toctree:: :hidden: diff --git a/sphinx/spread.rst b/sphinx/spread.rst index 478be9c..46c8c17 100644 --- a/sphinx/spread.rst +++ b/sphinx/spread.rst @@ -4,7 +4,7 @@ Spread The Word =============== Are you relying on a particular software packaged by |team| that is part -of the main Debian_ distribution? Or do you rely on the NeuroDebian +of the main Debian_ distribution? Or do you rely on the |repos|? If you think that this project is useful, please help us to make more people aware of Debian_ and NeuroDebian_ in particular. Sharing your positive experience with your friends and/or colleagues -- 2.39.5