<commit_before>Legal
=====

Copyright 2013 <NAME>

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Overview
========

DailyCashManager is graphical desktop application written in standard C++, using
C++11 features. It provides a means for individuals and households to
keep a record of their financial transactions, and to manage their
spending using the envelope budgeting system.

Dependencies
============

DailyCashManager is written in standard C++, and utilizes some C++11 features.
To build and install the application, you will need:

- A reasonably conformant C++ compiler and standard library implementation
  (DailyCashManager has been successfully built with GCC 4.7.2 and with
  later versions; it has not been tested with other compilers)

- A Tcl interpreter (known to work with version 8.6)

- CMake (version 2.8 or later)

- The Boost C++ libraries (version 1.53.0 or later)

- The Jewel C++ libraries (version 1.0.0 or later)

- The Sqloxx C++ libraries (version 1.0.0 or later)

- wxWidgets (version 2.9.3 or later)

- UnitTest++ (known to work with version 1.4)

To build the API documentation, you will need:

- Doxygen (known to work with version 1.8.3.1)

To build the user guide, you will need:

- Sphinx (documentation generator - known to work with version 1.1.3)
- sphinx-better-theme (known to work with version 0.1.4)

To build a binary installer for Windows, you will need:

- Nullsoft Scriptable Install System (NSIS) (known to work with version 2.46)

At the time of writing, these dependencies can be obtained from the following
locations:

:Tcl:           http://tcl.tk
:CMake:         http://www.cmake.org
:Boost:	        http://www.boost.org
:Jewel:         https://github.com/skybaboon/jewel
:Sqloxx:        https://github.com/skybaboon/sqloxx
:UnitTest++:	http://unittest-cpp.sourceforge.net
:Doxygen:	    http://www.stack.nl/~dimitri/doxygen
:Sphinx:        http://sphinx-doc.org
:sphinx-better-theme:       https://pypi.python.org/pypi/sphinx-better-theme
:NSIS:          http://nsis.sourceforge.net

Initial build configuration
===========================

Open a command line and ``cd`` to the project root.

On Unix-like systems, enter::

	cmake -i

(On Windows, you will need to use the ``-G`` option to choose a Makefile
generator, or else run ``cmake-gui.exe .``. See CMake documentation for further
details.)

You will be prompted with ``Would you like to see the advanced options? [No]:``.
Enter ``n``. Then follow the prompts.
<commit_msg>Minor fix in README.rst with .rst table format.<commit_after>Legal
=====

Copyright 2013 <NAME>

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Overview
========

DailyCashManager is graphical desktop application written in standard C++, using
C++11 features. It provides a means for individuals and households to
keep a record of their financial transactions, and to manage their
spending using the envelope budgeting system.

Dependencies
============

DailyCashManager is written in standard C++, and utilizes some C++11 features.
To build and install the application, you will need:

- A reasonably conformant C++ compiler and standard library implementation
  (DailyCashManager has been successfully built with GCC 4.7.2 and with
  later versions; it has not been tested with other compilers)

- A Tcl interpreter (known to work with version 8.6)

- CMake (version 2.8 or later)

- The Boost C++ libraries (version 1.53.0 or later)

- The Jewel C++ libraries (version 1.0.0 or later)

- The Sqloxx C++ libraries (version 1.0.0 or later)

- wxWidgets (version 2.9.3 or later)

- UnitTest++ (known to work with version 1.4)

To build the API documentation, you will need:

- Doxygen (known to work with version 1.8.3.1)

To build the user guide, you will need:

- Sphinx (documentation generator - known to work with version 1.1.3)
- sphinx-better-theme (known to work with version 0.1.4)

To build a binary installer for Windows, you will need:

- Nullsoft Scriptable Install System (NSIS) (known to work with version 2.46)

At the time of writing, these dependencies can be obtained from the following
locations:

:Tcl:                       http://tcl.tk
:CMake:                     http://www.cmake.org
:Boost:	                    http://www.boost.org
:Jewel:                     https://github.com/skybaboon/jewel
:Sqloxx:                    https://github.com/skybaboon/sqloxx
:UnitTest++:	            http://unittest-cpp.sourceforge.net
:Doxygen:	                http://www.stack.nl/~dimitri/doxygen
:Sphinx:                    http://sphinx-doc.org
:sphinx-better-theme:       https://pypi.python.org/pypi/sphinx-better-theme
:NSIS:                      http://nsis.sourceforge.net

Initial build configuration
===========================

Open a command line and ``cd`` to the project root.

On Unix-like systems, enter::

	cmake -i

(On Windows, you will need to use the ``-G`` option to choose a Makefile
generator, or else run ``cmake-gui.exe .``. See CMake documentation for further
details.)

You will be prompted with ``Would you like to see the advanced options? [No]:``.
Enter ``n``. Then follow the prompts.

{'fraction_non_alphanumeric': 0.10062582345191041, 'fraction_numerical': 0.015480895915678524, 'mean_word_length': 3.4951887490747593, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 6, 'lorem ipsum': 0, 'www.': 8, 'xml': 0}, 'pii_count': 2, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '440028', 'n_tokens_mistral': 1842, 'n_tokens_neox': 1697, 'n_words': 765}