diff --git a/INSTALL b/INSTALL index ca75efa4e..461e581f4 100644 --- a/INSTALL +++ b/INSTALL @@ -11,7 +11,7 @@ unlimited permission to copy, distribute and modify it. Pre-requisites -------------- -You will need the 'cmake' build system installed in order to build taskwarrior +You will need the CMake build system installed in order to build taskwarrior from source. Optionally, you might want to have Lua installed, if you wish to write plugins @@ -38,7 +38,7 @@ These commands are explained below: 2. Change directory to the root of the distribution. - 3. Invokes cmake to scan for dependencies and machine-specific details, then + 3. Invokes CMake to scan for dependencies and machine-specific details, then generate the makefiles. This may take a minute. 4. Builds taskwarrior. This may take a minute. @@ -61,13 +61,13 @@ To uninstall taskwarrior, you need the Makefiles, so if you deleted them in step 7 above, they must first be regenerated by following steps [1], [2] and [3]. Then simply run: - $ sudo make uninstall + $ sudo make uninstall TODO TODO TODO -- cmake doesn't include uninstall Taskwarrior Build Notes ----------------------- -Taskwarrior 1.9 has dependencies that are detected by cmake in almost all cases, +Taskwarrior 1.9.4 has dependencies that are detected by cmake in almost all cases, but there are situations and operating systems that mean you will need to offer a little help. @@ -76,7 +76,6 @@ System notes below. If this doesn't help, then go to the Troubleshooting section, which includes instructions on how to contact us for help. - Operating System Notes ---------------------- @@ -87,27 +86,38 @@ Haiku Alpha/R1 To switch from gcc 2.95 to gcc 4.x. +Cygwin + If 'make install' fails when writing to the /usr/local/share/ directory, + this may be because your current login doesn't have permission to write + to the Windows directory containing your Cygwin installation. Either + login to Windows as an Administrator and try the 'make install' process + again, or reinstall Cygwin under your normal Windows login. + + +Darwin + If you're having trouble with Lua, check to see if the include files were + installed. If you're using fink, this will require the lua51-dev package in + addition to lua51. Troubleshooting --------------- -In most cases, it is sufficient to run the configure program like this: +If you've recently made changes to dependencies (by reinstalling Lua, for +example) be sure to rerun 'cmake .' before trying to execute 'make' again. - $ ./configure - -Configure will run and locate all the necessary pieces for the build, and create -a Makefile. There may be errors and warnings when running configure, or there +CMake will run and locate all the necessary pieces for the build, and create +a Makefile. There may be errors and warnings when running CMake, or there may be compiler errors and warnings when running 'make'. Sometimes you will run -configure with no reported problems, and the build will fail later. This is -almost always because configure is mistaken about some assumption. +CMake with no reported problems, and the build will fail later. This is +almost always because CMake is mistaken about some assumption. -If a build does not succeed, please send the contents of the 'config.log' file -to support@taskwarrior.org, or post a message in the support forums at -taskwarrior.org along with the information. +If a build does not succeed, please send the contents of the 'CMakeCache.txt' +and 'CMakeFiles/CMakeOutput.log' files to support@taskwarrior.org, or post a +message in the support forums at taskwarrior.org along with the information. -If configure runs, but taskwarrior does not build, when ideally you would send -both the contents of config.log, and a transcript from the build, which is not -written to a file and must be captured from the terminal. +If CMake runs but taskwarrior does not build, please send the contents of the +above files as well as a transcript from the build, which is not written to a +file and must be captured from the terminal. ---