docs

README.md (docs directory)

The docs directory contains several markdown documents explaining how to perform a variety of tasks related to ShellCast.

Directory Contents

The markdown documents included in this directory are:

• ANALYSIS.md explains the various analysis scripts and how to set up the analysis cron job on a virtual computing lab image.
• CITATION.md explains how to cite and give attribution to ShellCast source code.
• DATABASE.md explains how to access, manage, and interact with the ShellCast database.
• DEVELOPER.md explains the structure of the repository, how to setup a full development environment, and how to perform common development tasks.
• LICENSE.md explains the ShellCast license.
• MANUAL_UPDATES.md explains how to make simple updates to ShellCast.

ShellCast Web Application Architecture Overview

For a schematic representation of the major components of the ShellCast web application and their relationships, see the ShellCast architecture overview flowchart.

Contact Information

If you have any questions, feedback, or suggestions please submit issues through the NCSU Enterprise GitHub or through GitHub (public). You can also reach out to Sheila Saia (ssaia at ncsu dot edu) or Natalie Nelson (nnelson4 at ncsu dot edu).