Skip to content

Commit

Permalink
Add changelog, license and update the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
binary-manu committed Nov 2, 2019
1 parent 3a85eec commit de37910
Show file tree
Hide file tree
Showing 3 changed files with 62 additions and 2 deletions.
20 changes: 20 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).

## [v2.46] - 2019-11-02

### Changed

* Replace literal magic numbers with constants.

### Added

* Wine/DosBox based build system.
* Dockerfile for building helper container.
* Added contributor information.
* MBR can be saved and restored either from the GUI or from the command line.
* CMOS data can be saved and restored either from the GUI or from the command
line.
21 changes: 21 additions & 0 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2019 Emanuele Giacomelli

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
23 changes: 21 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,16 @@ saved by the [Wayback Machine](https://archive.org/web/web.php). I tried
contacting the original author before releasing, but since this tool has been
discontinued since 2002 I may never get a response._

The main goal of this repository is to prevent this good, highly educational
piece of software from vanishing as time passes. While it is less relevant in
the era of UEFI and GPT, this program still has some uses and, more
importantly, provides a fantastic playground for people interested in
low-level, bare metal programming. As an example, this is one of those
program that handle protected mode switch by themselves.

I don't expect this repository to see further development, apart from keeping
the code base able to compile as the tools it uses (DosBox, Wine, ...) evolve.

## License

The original code didn't come with a license. My original work is distributed
Expand Down Expand Up @@ -74,7 +84,10 @@ some time and some GiB's of space.
### Project structure

.
├── CHANGELOG.md
├── docker
├── docs
├── LICENSE.txt
├── README.md
├── src
└── tools
Expand Down Expand Up @@ -129,15 +142,21 @@ With respect to v2.44, this version adds:
real time clock memory). This only covers the first 128 bytes of such data;
* command line versions of the operations above.

CMOS save/restore was meant as a simple ways to backup the current BIOS
configuration before experimenting with settings or changing the battery.
However, while it works well with some BIOSes, it totally fails with others.
It is import to test it on a system-by-system basis before relying on it to
produce usable backups.

### Command line options

The `/MBS`, `/MBL`, `/CMS` and `/CML` switches are used to save or load either
the MBR or CMOS data to or from a file. All of them take an extra `/F` options
which specifies the file used as the target of a store operation or as the
source for a load operation.

Additionally, `/CML` accepts a `/T` siwtch which defines how the date/time
information int the CMOS memory must be handled:
Additionally, `/CML` accepts a `/T` switch, which defines how the date/time
information within CMOS memory must be handled:

* if `/T` is not given, the current CMOS date/time is preserved (i.e. the
system time is not changed);
Expand Down

0 comments on commit de37910

Please sign in to comment.