root/branches/bud/docs/README.use

Revision 117, 2.4 kB (checked in by Gregor, 2 years ago)

docs/README, docs/README.use: Added a preliminary usage document.

Line 
1 This document describes the general use of DSSS.
2
3
4 Building Software with DSSS
5 ---------------------------
6
7 Most D software can be built with DSSS, but if it hasn't been set up for DSSS
8 the process is more complicated. To make things simple, we assume that the
9 software you're trying to compile has already been set up to use DSSS - if it
10 has not, read README.software_engineers.
11
12 Building software is quite easy. You simply have to extract the sources, and
13 change your directory to that of the sources, then invoke DSSS:
14 $ dsss build
15
16 DSSS will then proceed to build the software. 'dsss build' has several options,
17 but they're generally only useful for software distribution maintainers. You
18 can attain more information on them with the command:
19 $ dsss build --help
20
21 You can make DSSS remove all of the intermediate files it created, leaving only
22 the fully-compiled binaries and libraries, with the command:
23 $ dsss clean
24
25 Finally, you can cause DSSS to remove /all/ compiled files, essentially leaving
26 the source directory as it was before DSSS was used at all, with the command:
27 $ dsss distbuild
28
29
30 Installing Software with DSSS
31 -----------------------------
32
33 Some software can be used directly after building, but most software, libraries
34 in particular, expect to be installed somewhere. DSSS can install software to
35 any directory you choose, but will default to its own directory. After
36 building, to install software to the default directory (provided by DSSS),
37 invoke DSSS with the command:
38 $ dsss install
39
40 If you'd like to install the software to some other directory, you can specify
41 that directory with the "--prefix" option to DSSS, like so:
42 $ dsss install --prefix=<directory>
43
44 You can also uninstall previously installed software. For example, to uninstall
45 the hypothetical package "dhello":
46 $ dsss uninstall dhello
47
48
49 Acquiring Software with DSSS
50 ----------------------------
51
52 A very convenient feature of DSSS is its ability to install software from the
53 Internet. To install the hypothetical package "dhello" from DSSS' Internet
54 repository, use the command:
55 $ dsss net install dhello
56
57 Furthermore, DSSS can, from a source directory, install all of the dependencies
58 of that source. This allows developers to not concern themselves with whether
59 the dependencies for their software is installed, or where the sources come
60 from. To install the dependencies for the software you're building, just invoke
61 DSSS with the command:
62 $ dsss net deps
Note: See TracBrowser for help on using the browser.