summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorJoey Hess <joey@kodama.kitenet.net>2008-09-09 20:24:59 -0400
committerJoey Hess <joey@kodama.kitenet.net>2008-09-09 20:24:59 -0400
commitbc0130173b33d5f6c3e57436c5c2e0b646456030 (patch)
treed9ea07cda828c83f32d1e5bdefaf976991be1831 /README
parente44d829efe55680dfe2da9378ad45c429f6d1e9b (diff)
reformat
Diffstat (limited to 'README')
-rw-r--r--README28
1 files changed, 15 insertions, 13 deletions
diff --git a/README b/README
index fdb63227d..408ab666a 100644
--- a/README
+++ b/README
@@ -1,21 +1,23 @@
Use ./Makefile.PL to generate a Makefile, "make" will build the
documentation wiki and a man page, and "make install" will install ikiwiki.
-A few special variables you can set while using the Makefile:
+All other documentation is in the ikiwiki documentation wiki, which is also
+available online at <http://ikiwiki.info/>
-PROFILE=1 turns on profiling for the build of the doc wiki. Uses Devel::Profile
-NOTAINT=0 turns on the taint flag in the ikiwiki program. (Not recommended
-unless your perl is less buggy than mine -- see
-http://bugs.debian.org/411786)
+A few special variables you can set while using the Makefile:
-There are also other variables supported by MakeMaker, including PREFIX,
-INSTALL_BASE, and DESTDIR. See ExtUtils::MakeMaker(3).
+ PROFILE=1 turns on profiling for the build of the doc wiki.
+ (Uses Devel::Profile)
-In particular, INSTALL_BASE is very useful if you want to install ikiwiki
-to some other location, as it configures it to see the perl libraries
-there. See `doc/tips/nearlyfreespeech.mdwn` for an example of using this to
-install ikiwiki and its dependencies in a home directory.
+ NOTAINT=0 turns on the taint flag in the ikiwiki program. (Not recommended
+ unless your perl is less buggy than mine -- see
+ http://bugs.debian.org/411786)
-All other documentation is in the ikiwiki documentation wiki, which is also
-available online at <http://ikiwiki.info/>
+ There are also other variables supported by MakeMaker, including PREFIX,
+ INSTALL_BASE, and DESTDIR. See ExtUtils::MakeMaker(3).
+
+ In particular, INSTALL_BASE is very useful if you want to install ikiwiki
+ to some other location, as it configures it to see the perl libraries
+ there. See `doc/tips/nearlyfreespeech.mdwn` for an example of using this to
+ install ikiwiki and its dependencies in a home directory.