Docs before opening the source repo.

CONTRIBUTING.MD

@@ -0,0 +1,42 @@
+# Contributing to DOSCONTAINER
+
+We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
+
+- Reporting a bug
+- Discussing the current state of the code
+- Submitting a fix
+- Proposing new features
+- Creating a new game config or improving an existing one
+
+## We Develop with Area536 Gitea
+We use Area536 Gitea to host code, to track issues and feature requests, as well as accept merge requests.
+
+## Any contributions you make will be under the BSD 3-Clause license
+In short, when you submit code changes, your submissions are understood to be under the same license. See
+the LICENSE file included with this repository for details. You may add yourself as a contributor to this
+file.
+
+## Report bugs using GitLab's Issues feature
+
+Please do not use the MiSTer forum or other means. Only tracked issues in Gitea will actually exist and
+be considered. That's not to say nobody will respond on the forum, it's just not the authoritative source
+to find out the status of issues.
+
+**Great Bug Reports** tend to have:
+
+- A quick summary and/or background
+- Steps to reproduce
+  - Be specific!
+  - Give sample code if you can.
+- What you expected would happen
+- What actually happens
+- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
+
+People *love* thorough bug reports. I'm not even kidding.
+
+## License
+By contributing, you agree that your contributions will be licensed under the BSD 3-Clause license, see
+the LICENSE file for details.
+
+## Code of conduct
+We're all reasonable adults here. Behave like one or find out.

LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2024, Bas v.d. Wiel
+
+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.

README.MD

@@ -0,0 +1,52 @@
+# DOSContainer the framework
+
+This repository houses the framework of DOSContainer. The DOSContainer
+project started out over a year ago in response to me becoming aware of
+community-created "packs" of games. These come in the form of large hard
+drive images with a menu system layered on top, allowing for an easy end-user
+experience in playing a large number of retro games in platforms like the
+IBM-compatible PC and Amiga. While I tip my hat to the creators of these
+packs in admiration of their skill and dedication, these were not what I was
+personally looking for. DOSContainer was born.
+
+The version you see here is the newly imagined Rust version. It's mostly
+a rewrite of what is already there because Bash becomes very unwieldy.
+
+## So what is it?
+
+DOSContainer aims to be a tool that sits in the middle between the retro
+purist who does everything by hand, and the casual gamer who enjoys playing
+from game-packs. Note that there is absolutely no value judgement in there
+on my part. Everything goes, I'm just scratching my own personal itch here.
+Now if I had to try and sell DOSContainer it'd be something along the lines
+of a declarative solution to generating MS-DOS compatible hard drive images
+in a reliable and repeatable way. You can very easily mix and match different
+versions of operating systems, drivers and utilities with your games to see
+which combination is optimal for you. Just write a configuration YAML, run
+the script, and there you are.
+
+## What is it not?
+
+DOSContainer is not an emulator of any kind, nor is it intended to be usable
+by anyone besides myself. Yes, I'm selfish like that. I can write YAML and I
+consider it reasonable for a configuration format. So no graphical interface,
+or someone else should build that to spit out YAML's for them. I'm open to
+any suggestion in that regard.
+
+## How to use it
+
+At this point? You don't. The core features are not complete yet. Check out
+the CONTRIBUTING.MD file in the root of the project to find out how you can
+help.
+
+## Yes.. but.. PIRACY!
+
+Indeed. You're not supposed to pirate copyrighted works and all that. Yet I
+sourced every single file DOSContainer downloads from Archive.org, which offers
+them in the open and has been proudly doing so for years. Since I'm not really
+doing anything different, I'm assuming the rights holders don't mind or don't
+care enough. If you are a rights holder and you don't like what I'm doing,
+I will cooperate with any reasonable request sent to archive@area536.com to
+rectify any issues. If you're not a rights holder to any piece of software
+this project references, you're welcome to not use it but I'm not interested
+in hearing about it.