Store configuration in a separate object
[zeroinstall.git] / README
blob9c82b66a44b09982c5400d2baeed3060e86078b0
1 Zero Install
3 Copyright Thomas Leonard, 2010
6 INTRODUCTION
8 The 0launch command can be used to run a program, by giving it the program's
9 full name (a web address or "URL"). It does not need to be installed or run as
10 root. It does not write to any shared directories (like /usr/bin or /usr/lib).
11 It stores downloads in a cache directory so that you don't need to download
12 anything twice, and programs can still be used when you are off-line.
14 A complete program is made up of many different components, typically written
15 by different groups of people. Each component is available in multiple
16 versions. 0launch is used when starting a program. Its job is to decide
17 which implementation of each required component to use.
19 An interface describes what a component does. Zero Install starts with the
20 interface for the program you want to run (like 'The Gimp') and chooses an
21 implementation (like 'The Gimp 2.2.0'). However, this implementation will in
22 turn depend on other interfaces, such as 'GTK' (which draws the menus and
23 buttons). Thus, Zero Install must choose implementations of each dependancy
24 (each of which may require further interfaces, and so on).
26 See http://0install.net/injector.html for details.
29 INSTALLATION
31 Zero Install uses the normal Python distutils method of installation. To
32 install system-wide, run setup.py like this:
34   $ sudo python setup.py install
36 You can also install just to your home directory (this doesn't require root
37 access):
39   $ python setup.py install --home ~ --install-data ~/.local
40   $ export PATH=$HOME/bin:$PATH
42 Logging out and back in again will ensure $PATH and the Applications menu get
43 updated correctly, on Ubuntu at least.
46 USE
48 To run a program by its URI:
50   $ 0launch http://rox.sourceforge.net/2005/interfaces/Edit
52 To create a short-cut:
54   $ 0alias rox-edit http://rox.sourceforge.net/2005/interfaces/Edit
56 For more information, see the man-pages for 0launch, 0alias and 0store.
59 CONDITIONS
61 This library is free software; you can redistribute it and/or
62 modify it under the terms of the GNU Lesser General Public
63 License as published by the Free Software Foundation; either
64 version 2.1 of the License, or (at your option) any later version.
66 This library is distributed in the hope that it will be useful,
67 but WITHOUT ANY WARRANTY; without even the implied warranty of
68 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
69 Lesser General Public License for more details.
71 You should have received a copy of the GNU Lesser General Public
72 License along with this library; if not, write to the Free Software
73 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
76 BUG REPORTS
78 Please report any bugs to the mailing list:
80   http://0install.net/support.html