diff --git a/AUTHORS b/AUTHORS new file mode 100644 index 00000000..87b95049 --- /dev/null +++ b/AUTHORS @@ -0,0 +1,15 @@ +The development of Timewarrior was made possible by the significant +contributions of the following people: + + Paul Beckingham (Principal Author) + Federico Hernandez (Principal Author) + +The following submitted code, packages or analysis, and deserve special thanks: + + Renato Alves + +Thanks to the following, who submitted detailed bug reports and excellent +suggestions: + + - + diff --git a/CMakeLists.txt b/CMakeLists.txt index 78fc5405..93c8bbf6 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -102,7 +102,7 @@ configure_file ( add_subdirectory (src) -set (doc_FILES ChangeLog README.md) +set (doc_FILES NEWS ChangeLog README.md INSTALL AUTHORS COPYING LICENSE) foreach (doc_FILE ${doc_FILES}) install (FILES ${doc_FILE} DESTINATION ${TIMEW_DOCDIR}) endforeach (doc_FILE) diff --git a/COPYING b/COPYING new file mode 100644 index 00000000..6568e489 --- /dev/null +++ b/COPYING @@ -0,0 +1,23 @@ +Timewarrior - a command line time tracker + +Copyright 2015, Paul Beckingham, Federico Hernandez. + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included +in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL +THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + +http://www.opensource.org/licenses/mit-license.php diff --git a/INSTALL b/INSTALL new file mode 100644 index 00000000..10c77e9a --- /dev/null +++ b/INSTALL @@ -0,0 +1,139 @@ +Installation Instructions +------------------------- + +Please follow the instructions below to build and install Timewarrior from +source. + + +Dependencies +------------ + +You will need the CMake build system installed in order to build Timewarrior +from source. More information on cmake can be obtained at http://cmake.org + +You will also need: + - make + +You will need a C++ compiler that supports full C++11, which includes: + - gcc 4.7 (released 2012-03-23) + - clang 3.3 (released 2013-01-07) + + +Basic Installation +------------------ + +Briefly, these shell commands will unpack, build and install Timewarrior: + + $ tar xzf timew-X.Y.Z.tar.gz [1] + $ cd timew-X.Y.Z [2] + $ cmake . [3] + $ make [4] + $ sudo make install [5] + $ cd .. ; rm -r timew-X.Y.Z [6] + +These commands are explained below: + + 1. Unpacks the source tarball. This creates the directory timew-X.Y.Z, + containing all the code. + + 2. Change directory to the root of the distribution. + + 3. Invokes CMake to scan for dependencies and machine-specific details, then + generate the makefiles. This may take a minute. + + 4. Builds Timewarrior. This may take a minute. + + 5. Installs the program, documentation and other data files. + + 6. Removes the temporary directory. + + +Build and configurations options +-------------------------------- + +You can customize the configuration run with cmake variables. This will modify +the installation process: + +To change the installation directory you use the following configuration +variable: + + $ cmake -DCMAKE_INSTALL_PREFIX= . + +cmake configuration variables are applied with the -D option and consist of a + and a : + + $ cmake -D= . + +Four more variables can customize the installation process. The following table +lists them and their defaults plus the CMAKE_INSTALL_PREFIX: + + CMAKE_INSTALL_PREFIX /usr/local + TIMEW_BINDIR bin + TIMEW_DOCDIR share/doc/task + TIMEW_RCDIR share/doc/task/rc + TIMEW_MAN1DIR share/man/man1 + TIMEW_MAN5DIR share/man/man5 + +The corresponding TIMEW_* variables will be combined with CMAKE_INSTALL_PREFIX to +get absolute installation directories: + + CMAKE_INSTALL_PREFIX/TIMEW_BINDIR /usr/local/bin + CMAKE_INSTALL_PREFIX/TIMEW_DOCDIR /usr/local/share/doc/task + CMAKE_INSTALL_PREFIX/TIMEW_RCDIR /usr/local/share/doc/task/rc + CMAKE_INSTALL_PREFIX/TIMEW_MAN1DIR /usr/local/share/man/man1 + CMAKE_INSTALL_PREFIX/TIMEW_MAN5DIR /usr/local/share/man/man5 + + +Uninstallation +-------------- + +There is no uninstall option in CMake makefiles. This is a manual process. + +To uninstall Timewarrior, remove the files listed in the install_manifest.txt +file that was generated when you built Timewarrior. + + +Timewarrior Build Notes +----------------------- + +Timewarrior 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. + +If Timewarrior will not build on your system, first take a look at the Operating +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 +---------------------- + +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. + + +Troubleshooting +--------------- + +If you've recently made changes to dependencies (by reinstalling them, for +example) be sure to rerun 'cmake .' before trying to execute 'make' again. + +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 +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 '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 CMake runs but Timewarrior 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. + +--- diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..8a6c8beb --- /dev/null +++ b/LICENSE @@ -0,0 +1,23 @@ +Timewarrior - a command line time tracker + +Copyright 2006 - 2015, Paul Beckingham, Federico Hernandez. + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included +in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL +THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + +http://www.opensource.org/licenses/mit-license.php diff --git a/NEWS b/NEWS new file mode 100644 index 00000000..bba9303c --- /dev/null +++ b/NEWS @@ -0,0 +1,45 @@ + +New Features in 1.0.0 + + - + +New Commands in 1.0.0 + + - + +New Configuration Options in 1.0.0 + + - + +Newly Deprecated Features in 1.0.0 + + - None, this is the first release. + +Removed Features in 1.0.0 + + - None, this is the first release. + +Known Issues + + - https://bug.tasktools.org/ + +Timewarrior has been built and tested on the following configurations: + + * OS X + +--- + +While Timewarrior has undergone testing, bugs are sure to remain. If you +encounter a bug, please enter a new issue at: + + https://bug.tasktools.org + +Or you can also report the issue in the forums at: + + https://answers.tasktools.org + +Or just send a message to: + + support@taskwarrior.org + +Thank you.