This README.txt file was generated on 20200726 by Michael Coblenz.

#
# General instructions for completing README: 
# For sections that are non-applicable, mark as N/A (do not delete any sections). 
# Please leave all commented sections in README (do not delete any text). 
#

-------------------
GENERAL INFORMATION
-------------------

1. Title of Dataset:

#
# Authors: Include contact information for at least the 
# first author and corresponding author (if not the same), 
# specifically email address, phone number (optional, but preferred), and institution. 
# Contact information for all authors is preferred.
#

2. Author Information
<create a new entry for each additional author>

First Author Contact Information
    Name: Michael Coblenz
    Institution: Carnegie Mellon University
    Address: 5000 Forbes Ave.
    Email: mcoblenz@cs.cmu.edu
	Phone Number: 


Corresponding Author Contact Information
    Name: Michael Coblenz
    Institution: Carnegie Mellon University
    Address: 5000 Forbes Ave.
    Email: mcoblenz@cs.cmu.edu
	Phone Number: 

Author Contact Information (if applicable)
    Name: Whitney Nelson
    Institution: 
    Address:
    Email: whitneyux@gmail.com
	Phone Number: 

    Name: Jonathan Aldrich
    Institution: Carnegie Mellon University
    Address: 5000 Forbes Ave.
    Email: jonathan.aldrich@cs.cmu.edu
	Phone Number: 


    Name: Brad Myers
    Institution: Carnegie Mellon University
    Address: 5000 Forbes Ave.
    Email: bam@cs.cmu.edu
	Phone Number: 

    Name: Joshua Sunshine
    Institution: Carnegie Mellon University
    Address: 5000 Forbes Ave.
    Email: bam@cs.cmu.edu
	Phone Number: 


---------------------
DATA & FILE OVERVIEW
---------------------

#
# Directory of Files in Dataset: List and define the different 
# files included in the dataset. This serves as its table of 
# contents. 
#

Directory of Files:
   A. Filename: Glacier.zip       
      Short description: This is an archive of the Glacier software package (https://github.com/mcoblenz/Glacier) as of 4f2b3d9486d441483f3f8997feb03e134953a201. The archive includes is a replication package for the experiments in the Glacier user study. The results of this study were published at ICSE 2017.       


Additional Notes on File Relationships, Context, or Content 
(for example, if a user wants to reuse and/or cite your data, 
what information would you want them to know?):              

Please cite the ICSE paper: 

Michael Coblenz, Whitney Nelson, Jonathan Aldrich, Brad A. Myers, Joshua Sunshine. "Glacier: Transitive Class Immutability for Java." The 39th International Conference on Software Engineering (ICSE 2017), Buenos Aires, Argentina, May 20-28, 2017.

Glacier will need to be updated if it needs to work with a more recent version of the Checker framework. Version 3.5 (and likely earlier versions) are known to have incompatible changes.

#
# File Naming Convention: Define your File Naming Convention 
# (FNC), the framework used for naming your files systematically 
# to describe what they contain, which could be combined with the
# Directory of Files. 
#

File Naming Convention: Files are named as in the GitHub repository so that the package can be built.


#
# Data Description: A data description, dictionary, or codebook
# defines the variables and abbreviations used in a dataset. This
# information can be included in the README file, in a separate 
# file, or as part of the data file. If it is in a separate file
# or in the data file, explain where this information is located
# and ensure that it is accessible without specialized software.
# (We recommend using plain text files or tabular plain text CSV
# files exported from spreadsheet software.) 
#



-----------------------------------------
DATA DESCRIPTION FOR: [FILENAME]
-----------------------------------------
N/A

--------------------------
METHODOLOGICAL INFORMATION
--------------------------

#
# Software: If specialized software(s) generated your data or
# are necessary to interpret it, please provide for each (if
# applicable): software name, version, system requirements,
# and developer. 
#If you developed the software, please provide (if applicable): 
#A copy of the software’s binary executable compatible with the system requirements described above. 
#A source snapshot or distribution if the source code is not stored in a publicly available online repository.
#All software source components, including pointers to source(s) for third-party components (if any)

1. Software-specific information:
<create a new entry for each qualifying software program>

Name: Glacier
Version: 0.1
System Requirements: Checker Framework 2.1.2 (http://checkerframework.org); Java 1.8
Open Source? (Y/N): Y

(if available and applicable)
Executable URL:
Source Repository URL: https://github.com/mcoblenz/Glacier
Developer: Michael Coblenz
Product URL:
Software source components:


Additional Notes(such as, will this software not run on 
certain operating systems?):

The software should work on any operating system that supports Java 1.8 and Checker Framework 2.1.2. The archive includes a README that gives instructions for building Glacier.

#
# Equipment: If specialized equipment generated your data,
# please provide for each (if applicable): equipment name,
# manufacturer, model, and calibration information. Be sure
# to include specialized file format information in the data
# dictionary.
#

2. Equipment-specific information:
N/A

#
# Dates of Data Collection: List the dates and/or times of
# data collection.
#

3. Date of data collection (single date, range, approximate date) <suggested format YYYYMMDD>:

The snapshot was taken from GitHub on July 26, 2020.