Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
glesica committed Apr 8, 2022
0 parents commit a2cbd84
Show file tree
Hide file tree
Showing 5 changed files with 104 additions and 0 deletions.
2 changes: 2 additions & 0 deletions AUTHORS
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Susan Student <[email protected]>
Travis Wheeler <[email protected]>
12 changes: 12 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
FROM ubuntu:20.04

RUN apt-get -q update && \
apt-get -y install \
build-essential \
make && \
rm -rf /var/lib/apt/lists/* && \
mkdir -p /code

VOLUME /code
WORKDIR /code

26 changes: 26 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
Copyright 2020 AUTHORS

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors
may be used to endorse or promote products derived from this software without
specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
56 changes: 56 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# Project

**REPLACE:** One sentence description of the project.

## About

**REPLACE:** Describe your project in more detail. What does it do? Who are the intended
users? Why is it important or meaningful? How does it improve upon similar
software? Is it a component of or extension to a larger piece of software?

## Installation

**REPLACE:** How does on install the software? What are the dependencies, if any? Is there a
Docker image or installation package of some sort?

## Usage

**REPLACE:** How is the software run (or consumed, for libraries)? Are there any command line
flags the user should know about? What do they do, exactly? What do the input
data look like? Are there special file formats in use, what are they? What does
the output look like?

## Development

**REPLACE:** What language(s) are in use? What does a user need to install for development
purposes? This might include build systems, Docker, a particular compiler or
runtime version, test libraries or tools, linters, code formatters, or other
tools. Are there any special requirements, like processor architecture? What
commands should developers use to accomplish common tasks like building, running
the test suite, and so on?

## Contributing

We welcome external contributions, although it is a good idea to contact the
maintainers before embarking on any significant development work to make sure
the proposed changes are a good fit.

Contributors agree to license their code under the license in use by this
project (see `LICENSE`).

To contribute:

1. Fork the repo
2. Make changes on a branch
3. Create a pull request

## License

See `LICENSE` for details.

## Authors

**REPLACE:** Who should people contact with questions?

See `AUTHORS` the full list of authors.

8 changes: 8 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Release Instructions

**REPLACE:** How does one generate a new release of the software? Ideally, this
should be an automated process, but there may still be a handful of steps. It is
also good to describe, at a high level, what the release script does. For
example, create a Git tag, increment the version number in a particular file,
create a release on GitHub, and so on.

0 comments on commit a2cbd84

Please sign in to comment.