forked from leo-editor/leo-editor
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathINSTALL.TXT
157 lines (104 loc) · 5.3 KB
/
INSTALL.TXT
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
@language rest
System requirements
-------------------
Leo requires the `Python`_ and `PyQt_` package.
The `PyEnchant`_ package is optional.
**Python**: Leo will work on any platform that supports Python 2.6 or
above, including Python 3.0 and above. To install Python, see
http://python.org.
**PyQt**: PyQt provides Leo's widgets. To install PyQt, get the binary
package from: http://www.riverbankcomputing.co.uk/software/pyqt/download
The PyQt version must match your installed Python version. Remember that
Leo requires Python 2.6 or later, or Python 3.0 or later. Now run the
binary PyQt installer.
**PyEnchant**: You must install the PyEnchant package if you want to use
Leo's Spell tab. Download and install the PyEnchant package from
http://pythonhosted.org/pyenchant/download.html There is an executable
installer for Windows users.
Leo's HOME directory
--------------------
Python's HOME environment variable specifies Leo's HOME directory.
See http://docs.python.org/lib/os-procinfo.html for details.
Leo puts several files in your HOME/.leo directory:
.leoID.txt, .leoRecentFiles.txt, and myLeoSettings.leo.
There are various fallback directories if there is no home directory.
Installing Leo on Linux
-----------------------
You may download Leo's sources in one of three ways, as described at:
http://leoeditor.com/download.html If the sources are zipped, unzip them
into a folder in your home directory, say ~/leo-5.2 (or /usr/bin, etc.)
To gain access to Leo, you have two choices:
A. Add ~/leo-5.2 to your path.
B. Create alias for Leo.
I prefer using aliases because they allow me to start Leo using Python 2 or 3,
or other distributions, like Anaconda 2 or 3.
See `Running Leo`_ for how to run Leo after installing it.
Installing Leo on Windows
--------------------------
Install Python and Qt, as described above.
Now you have a choice. You can use Leo's binary (single-click) installer
or download Leo's sources directly.
1. Using the single-click installer
Leo has a binary installer for Windows, available at
http://sourceforge.net/projects/leo/files/Leo/ The binary installer
installs Leo and sets Windows file associations.
2. Installing from sources
You may download Leo's sources in one of three ways, as described at:
http://leoeditor.com/download.html If the sources are zipped, unpack them
into a temp folder. You may place the sources anywhere you like, including
Python's *site-packages* folder, for example,
C:\Python26\Lib\site-packages.
Running Leo
-----------
You can run Leo from a Python interpreter as follows::
import leo
leo.run() # runs Leo, opening a new outline or,
leo.run(fileName=aFileName) # runs Leo, opening the given file name.
Another way to run Leo is as follows::
cd <path-to-launchLeo.py>
python launchLeo.py
Creating File Associations
--------------------------
**Linux**
The following shell script will allow you to open foo.leo files by typing leo foo::
#!/bin/sh
python <leopath>launchLeo.py $1
where <leopath> is the path to the directory *containing* the leo directory.
**Windows**
*Important*: Leo's binary Windows installer sets file associations
automatically, so this section is needed only if you are installing Leo
from a .zip file or other sources.
There are two ways of associating .leo files with Leo. The first uses the
Windows control panel, the second, the Windows console.
**Method 1: Using the Windows Control Panel**
The goal is that you want to associate .leo files with the following command::
"<path to python>\python.exe" "<path to launchLeo.py>\launchLeo.py" "%1"
Before Windows 7, you do this with using the Folder Options control panel.
In Windows 7, you do this with the Default Programs control panel.
*Note*: "%1" passes just the file being clicked on, quoted for spaces etc.
The quotation marks are needed to handle file paths containing spaces.
*Warning:* In a batch file, %1 passes just the first command line parameter.
It is logical to expect %* to work for file associations just as in batch
files. Alas, it does not.
**Method 2: Using the Windows Console**
Open a Windows console with administrator privileges, then type::
ftype LeoFile="<path to python>\pythonw.exe" "<path to launchLeo.py>\launchLeo.py" "%1" %*
assoc .leo=LeoFile
And put this leo.bat in %PATH%::
@start /b "Leo" "<path to python>\python.exe" "<path to launchLeo.py>\launchLeo.py" %*
You may omit the /b option if you want to create a separate console window for Leo.
Adding Leo to Your Path
-----------------------
After you have installed Leo, you should add the location of your leo/core folder to your python path.
One way to do this is adding something like the following to python/Lib/sitecustomize.py:
import sys
sys.path.append(r'<path-to-leo>leo\core')
Another way is to append <path-to-leo> to the Windows PYTHONPATH environment variable.
Running Leo for the first time
------------------------------
The first time you start Leo, a dialog will ask you for a unique identifier. If
you are using cvs, use your cvs login name. Otherwise your initials will do. Leo
stores this identifier in the file ``.leoID.txt``. Leo attempts to create
``leoID.txt`` in the .leo sub-directory of your home directory, then in Leo's config directory, and
finally in Leo's core directory. You can change this identifier at any time by
editing ``.leoID.txt``.