Skip to content

Commit

Permalink
feat: Add README, update file naming and references
Browse files Browse the repository at this point in the history
This commit introduces a new README.md file with basic project information and placeholders for future sections. It also renames 'code-of-conduct.md' to 'CODE_OF_CONDUCT.md' for consistency. All references to the code of conduct within markdown files have been updated to reflect the name change. Additionally, it sets up a placeholder file for codeowners.
  • Loading branch information
alismx committed Jan 31, 2025
1 parent 15365cf commit ee09cab
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 1 deletion.
1 change: 1 addition & 0 deletions CODEOWNERS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Placeholder for future codeowners
File renamed without changes.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ collaborative environment.

Before contributing, we encourage you to also read our [LICENSE](LICENSE),
[README](README.md), and
[code-of-conduct](code-of-conduct.md)
[code-of-conduct](CODE_OF_CONDUCT.md)
files, also found in this repository. If you have any inquiries or questions not
answered by the content of this repository, feel free to [contact us](mailto:dibbs@cdc.gov).

Expand Down
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# DIBBS VM

## Table of Contents
- [DIBBS VM](#dibbs-vm)
- [Table of Contents](#table-of-contents)
- [Overview](#overview)
- [Searchable Documentation](#searchable-documentation)
- [Getting Started](#getting-started)
- [Code of Conduct](#code-of-conduct)
- [Contributing](#contributing)
- [License](#license)

## Overview
DIBBS (Data Ingestion Building Blocks) VM (Virtual Machine) is a project that aims to provide a VM that can be used to run the DIBBS software stacks.

## Searchable Documentation
_Coming soon!_

## Getting Started
_Also coming soon!_

## Code of Conduct
Please refer to our [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) for more information on how we conduct ourselves in this project.

## Contributing
To contribute, refer to our [CONTRIBUTING.md](CONTRIBUTING.md).

## License
[License](LICENSE)

0 comments on commit ee09cab

Please sign in to comment.