Re: [PROPOSAL] Quick and easy installation instructions

From: John Hendy <jw.hendy@gmail.com>
To: Dan Davison <davison@stats.ox.ac.uk>
Cc: emacs org-mode mailing list <emacs-orgmode@gnu.org>
Subject: Re: [PROPOSAL] Quick and easy installation instructions
Date: Sun, 26 Sep 2010 09:51:05 -0500	[thread overview]
Message-ID: <AANLkTi=+pGhccKUEMqEZZ5RsXaTkNu316SJbEaPNGTt_@mail.gmail.com> (raw)
In-Reply-To: <87tylcy6gw.fsf@stats.ox.ac.uk>

[-- Attachment #1.1: Type: text/plain, Size: 2458 bytes --]

On Sun, Sep 26, 2010 at 8:33 AM, Dan Davison <davison@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 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
>

[-- Attachment #1.2: Type: text/html, Size: 3446 bytes --]

[-- Attachment #2: Type: text/plain, Size: 201 bytes --]

_______________________________________________
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