From mboxrd@z Thu Jan 1 00:00:00 1970 From: John Hendy Subject: Re: [PROPOSAL] Quick and easy installation instructions Date: Sun, 26 Sep 2010 09:51:05 -0500 Message-ID: References: <87tylcy6gw.fsf@stats.ox.ac.uk> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="===============0031123945==" Return-path: Received: from [140.186.70.92] (port=50839 helo=eggs.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1OzsZJ-0008QS-RY for emacs-orgmode@gnu.org; Sun, 26 Sep 2010 10:51:11 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.69) (envelope-from ) id 1OzsZI-00064G-7U for emacs-orgmode@gnu.org; Sun, 26 Sep 2010 10:51:09 -0400 Received: from mail-bw0-f41.google.com ([209.85.214.41]:55753) by eggs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1OzsZH-00063p-Th for emacs-orgmode@gnu.org; Sun, 26 Sep 2010 10:51:08 -0400 Received: by bwz10 with SMTP id 10so3836074bwz.0 for ; Sun, 26 Sep 2010 07:51:06 -0700 (PDT) In-Reply-To: <87tylcy6gw.fsf@stats.ox.ac.uk> List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org Errors-To: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org To: Dan Davison Cc: emacs org-mode mailing list --===============0031123945== Content-Type: multipart/alternative; boundary=000325556b62d0e9cf04912abd29 --000325556b62d0e9cf04912abd29 Content-Type: text/plain; charset=ISO-8859-1 On Sun, Sep 26, 2010 at 8:33 AM, Dan Davison wrote: > I think that the documentation concerning installation should be made > more user-friendly. My impression is that the Org manual makes all this > sound much harder than it needs to be, and I suspect that this is an > entry-barrier for new Org users. For example, the first thing users > encounter in the manual section is an instruction to edit a Makefile. > > I suggest we provide a "quick and easy installation" section to the > manual... Very cool idea! This would probably get quite redundant... but I wonder about "extras" as well. Early in my Org-mode experience I would see "cool" things like ditaa or gnuplot and want to get set up. While there are often references to other documentation sets, I won't say that things were exactly easy. Anyway, again this will be somewhat redundant since other groups maintain their own documentation, but I could see a good in keeping some kind of Worg section on "modular functionality" with some help for that? John > > > Example quick and Easy installation text: > ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ > > 1. Download the latest version > .zip and .tar.gz version are kept at > http://orgmode.org/org-latest.zip > http://orgmode.org/org-latest.tar.gz > > 2. Extract the archived files > This will create a folder called "org-mode". Let's say that the > location of this folder is "~/path/to/org-mode" (for Windows see > footnote [1]) > > 3. Add the following lines to your .emacs file (note that we're pointing > to the "lisp" folder *within* the main "org-mode" folder): > > (setq load-path (cons "~/path/to/org-mode/lisp" load-path) > (require 'org-install) > > That's it. However, this will not install the latest info files, so > these will be out of date (corresponding to whatever version of Org > shipped with your emacs). See XXXX for instructions on installing the > info files. > > Now, Emacs should load whatever version of Org-mode you put at > "~/path/to/org-mode". So to update Org in the future, simply delete that > folder and replace it with a new one (steps 1 and 2 above). > > Footnotes: > > [1] On Windows, this path might look something like > "C:\\path\to\org-mode" > > _______________________________________________ > Emacs-orgmode mailing list > Please use `Reply All' to send replies to the list. > Emacs-orgmode@gnu.org > http://lists.gnu.org/mailman/listinfo/emacs-orgmode > --000325556b62d0e9cf04912abd29 Content-Type: text/html; charset=ISO-8859-1 Content-Transfer-Encoding: quoted-printable

On Sun, Sep 26, 2010 at 8:33 AM, Dan Dav= ison <daviso= n@stats.ox.ac.uk> wrote:
I think that the documentation concerning installation should be made
more user-friendly. My impression is that the Org manual makes all this
sound much harder than it needs to be, and I suspect that this is an
entry-barrier for new Org users. For example, the first thing users
encounter in the manual section is an instruction to edit a Makefile.

I suggest we provide a "quick and easy installation" section to t= he
manual...

Very cool idea! This would probab= ly get quite redundant... but I wonder about "extras" as well. Ea= rly in my Org-mode experience I would see "cool" things like dita= a or gnuplot and want to get set up. While there are often references to ot= her documentation sets, I won't say that things were exactly easy. Anyw= ay, again this will be somewhat redundant since other groups maintain their= own documentation, but I could see a good in keeping some kind of Worg sec= tion on "modular functionality" with some help for that?


John

=A0
<= blockquote class=3D"gmail_quote" style=3D"margin:0 0 0 .8ex;border-left:1px= #ccc solid;padding-left:1ex;">

Example quick and Easy installation text:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

1. Download the latest version
=A0 .zip and .tar.gz version are kept at
=A0 http:/= /orgmode.org/org-latest.zip
=A0 htt= p://orgmode.org/org-latest.tar.gz

2. Extract the archived files
=A0 This will create a folder called "org-mode". Let's say t= hat the
=A0 location of this folder is "~/path/to/org-mode" (for Windows= see
=A0 footnote [1])

3. Add the following lines to your .emacs file (note that we're pointin= g
=A0 to the "lisp" folder *within* the main "org-mode" = folder):

=A0 (setq load-path (cons "~/path/to/org-mode/lisp" load-path) =A0 (require 'org-install)

That's it. However, this will not install the latest info files, so
these will be out of date (corresponding to whatever version of Org
shipped with your emacs). See XXXX for instructions on installing the
info files.

Now, Emacs should load whatever version of Org-mode you put at
"~/path/to/org-mode". So to update Org in the future, simply dele= te that
folder and replace it with a new one (steps 1 and 2 above).

Footnotes:

[1] On Windows, this path might look something like
"C:\\path\to\org-mode"

_______________________________________________
Emacs-orgmode mailing list
Please use `Reply All' to send replies to the list.
Emacs-orgmode@gnu.org
http://lists.gnu.org/mailman/listinfo/emacs-orgmode

--000325556b62d0e9cf04912abd29-- --===============0031123945== Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Content-Disposition: inline _______________________________________________ Emacs-orgmode mailing list Please use `Reply All' to send replies to the list. Emacs-orgmode@gnu.org http://lists.gnu.org/mailman/listinfo/emacs-orgmode --===============0031123945==--