cdss-app-tstool-doc
This repository contains the legacy Word/PDF TSTool software documentation, including user manual, training materials, and a variety of developer resources.
This documentation is being phased out in favor of new Markdown/MkDocs documentation. In general, do not edit this documentation and only use as a reference when migrating into the newer format. See the TSTool Developer Documentation and TSTool User Documentation repositories.
See the following online resources:
The developer documentation and guidelines will be updated as the development environment is used in development. See the following sections in this page:
- Repository Folder Structure
- Repository Dependencies
- Development Environment Folder Structure
- Contributing
- License
- Contact
Repository Folder Structure
The following are the main folders and files in this repository, listed alphabetically. See also the Development Environment Folder Structure for overall folder structure recommendations.
cdss-app-tstool-doc/ TSTool Word/PDF documentation files.
.git/ Git repository folder (DO NOT MODIFY THIS except with Git tools).
.gitattributes Git configuration file for repository.
.gitignore Git configuration file for repository.
.project Eclipse configuration file (general file project).
doc/ Documentation files.
DeveloperResources/ Developer resources.
HowTo/ Helpful notes.
QuickStart/ Examples of how to use TSTool.
Training/ Training lessons.
UserManual/ User manual files.
LICENSE.txt TSTool documentation license file.
README.md This file.
test/ Functional tests used in documentation examples.
Repository Dependencies
Repository dependencies fall into two categories as indicated below.
TSTool Documentation Repository Dependencies
None, although more information may be added here later about PDF merge utilities. Such utilities are no longer needed given that this documentation is no longer used.
Repositories that Depend on This Repository
| Repository | Description |
|---|---|
cdss-app-tstool-main |
Main TSTool software repository/project. |
Development Environment Folder Structure
See the TSTool main software repository for information about the TSTool development environment folder structure.
Contributing
Contributions to this project can be submitted using the following options:
- TSTool software developers with commit privileges can write to this repository as per normal OpenCDSS development protocols.
- Post an issue on GitHub with suggested change. Provide information using the issue template.
- Fork the repository, make changes, and do a pull request.
See also the OpenCDSS / TSTool protocols.
License
This documentation is released under the Creative Commons Attribution 4.0 International License (CC BY 4.0). See the LICENSE.md file.
The TSTool software is released under the GPL v3 license. This legacy documentation has not been updated to reflect this, given that a new version of the documentation is available.