<commit_before>Mirus [![Build Status](https://travis-ci.org/joshbeitler/mirus.png?branch=master)](https://travis-ci.org/joshbeitler/mirus) [![Version](http://calm-shore-6115.herokuapp.com/?label=version&value=sv0.1.0&color=green)](http://semver.org)
=====
Mirus is a hobby operating system designed to be a playground for new and interesting OS theories.  It is not based on any other exsisting standards, allowing for a great deal of freedom in the development of the concepts behind it.

## Testing

### Note on Source Structure
You may notice that `readme.markdown` and `license.txt` are symbolic links to accordingly named files in the `support` directory.  In the Mirus world, to keep things clean, files such as READMEs, CONTRIBUTING, Licenses, and related files are moved into a directory called `support`.  You will notice this trend in projects related to Mirus (mirloader, mkdb, mircore, etc.), as well as a lot of applications that run on Mirus.  To not cause any confusion, we have symlinked the README and LICENSE files to the root directory.  Please note that this is not always the case, and also that the symlinks may cause troubles in web-based source viewers.

### Dependencies
Mirus depends on `clang`, `grub2`, `xorriso`, `ld`, and `nasm` to build the kernel.

### Building
First of all, make sure that you have the most up-to-date source, via `git rebase`.  To  perform a build, simply run `make` on the source root.  The `mirus.iso` file is what you are looking for.  Additional makefile targets can be found in the `support/BUILDING` file.  To learn more about the source and how the directories are formatted, look in `support/source-overview`.

### Running
You can burn the ISO image to a disk (CD/DVD) and run it on actual hardware, or in a virtual machine.  We mainly support QEMU and VirtualBox, though most (if not all) capable virtual machines can run it.  We try to keep Mirus compatable with most up-to-date modern hardware.

### Debugging
Mirus has mouthwatering deugging capabilities to make the life of kernel developers easier.  If you build Mirus with the `make debug` target, the kernel image will be compiled with additional debugging symbols and information for `mkdb`, the Mirus kernel debugger.  You can debug Mirus with `mkdb` and `gdb`. In addition Mirus uses serial ports to provide on-the-fly debugging information (two way) when compiled with the `debug` flag.  You can view these logs with `tail -f` or a similar utility.  More information on debugging can be found on the wiki or in the `docs` directory.<commit_msg>Clarified last sentance of notice<commit_after>Mirus [![Build Status](https://travis-ci.org/joshbeitler/mirus.png?branch=master)](https://travis-ci.org/joshbeitler/mirus) [![Version](http://calm-shore-6115.herokuapp.com/?label=version&value=sv0.1.0&color=green)](http://semver.org)
=====
Mirus is a hobby operating system designed to be a playground for new and interesting OS theories.  It is not based on any other exsisting standards, allowing for a great deal of freedom in the development of the concepts behind it.

## Testing

### Note on Source Structure
You may notice that `readme.markdown` and `license.txt` are symbolic links to accordingly named files in the `support` directory.  In the Mirus world, to keep things clean, files such as READMEs, CONTRIBUTING, Licenses, and related files are moved into a directory called `support`.  You will notice this trend in projects related to Mirus (mirloader, mkdb, mircore, etc.), as well as a lot of applications that run on Mirus.  To not cause any confusion, we have symlinked the README and LICENSE files to the root directory.  Please note that this is not always the case, and also that the symlinks may cause troubles in web-based source viewers that do not support symbolic links.

### Dependencies
Mirus depends on `clang`, `grub2`, `xorriso`, `ld`, and `nasm` to build the kernel.

### Building
First of all, make sure that you have the most up-to-date source, via `git rebase`.  To  perform a build, simply run `make` on the source root.  The `mirus.iso` file is what you are looking for.  Additional makefile targets can be found in the `support/BUILDING` file.  To learn more about the source and how the directories are formatted, look in `support/source-overview`.

### Running
You can burn the ISO image to a disk (CD/DVD) and run it on actual hardware, or in a virtual machine.  We mainly support QEMU and VirtualBox, though most (if not all) capable virtual machines can run it.  We try to keep Mirus compatable with most up-to-date modern hardware.

### Debugging
Mirus has mouthwatering deugging capabilities to make the life of kernel developers easier.  If you build Mirus with the `make debug` target, the kernel image will be compiled with additional debugging symbols and information for `mkdb`, the Mirus kernel debugger.  You can debug Mirus with `mkdb` and `gdb`. In addition Mirus uses serial ports to provide on-the-fly debugging information (two way) when compiled with the `debug` flag.  You can view these logs with `tail -f` or a similar utility.  More information on debugging can be found on the wiki or in the `docs` directory.
{'fraction_non_alphanumeric': 0.07405978784956606, 'fraction_numerical': 0.003085824493731919, 'mean_word_length': 4.4994697773064685, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 4, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2064463', 'n_tokens_mistral': 1410, 'n_tokens_neox': 1380, 'n_words': 759}