~groovestomp/gsnes

3a818931f93abefdd6fa9659750632b2e0062caf — GrooveStomp 1 year, 5 months ago dc345d3
Documentation
M .doxygen.conf => .doxygen.conf +3 -5
@@ 791,9 791,7 @@ WARN_LOGFILE           =
# Note: If this tag is empty the current directory is searched.

INPUT                  = ./ \
                         docs/doc_mainpage.txt \
                         docs/doc_development.txt \
                         docs/doc_license.txt
                         README.md

# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses


@@ 875,7 873,7 @@ RECURSIVE              = NO
# Note that relative paths are relative to the directory from which doxygen is
# run.

EXCLUDE                =
EXCLUDE                = stb_truetype.h

# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
# directories that are symbolic links (a Unix file system feature) are excluded


@@ 984,7 982,7 @@ FILTER_SOURCE_PATTERNS =
# (index.html). This can be useful if you have a project on for instance GitHub
# and want to reuse the introduction page also for the doxygen output.

USE_MDFILE_AS_MAINPAGE =
USE_MDFILE_AS_MAINPAGE = README.md

#---------------------------------------------------------------------------
# Configuration options related to source browsing

M LICENSE => LICENSE +2 -2
@@ 633,8 633,8 @@ the "copyright" line and a pointer to where the full notice is found.
    Copyright (C) <year>  <name of author>

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU Affero General Public License as published
    by the Free Software Foundation, either version 3 of the License, or
    it under the terms of the GNU Affero General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,

A LICENSE-OLC-3 => LICENSE-OLC-3 +11 -0
@@ 0,0 1,11 @@
Copyright 2018, 2019 OneLoneCoder.com

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

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

2. Redistributions or derivative works in binary form must reproduce the above copyright notice. This list of conditions and the following disclaimer must be reproduced 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.
\ No newline at end of file

A README.md => README.md +38 -0
@@ 0,0 1,38 @@
# GrooveStomp's NES Emulator
[![AGPLv3 license](https://img.shields.io/badge/License-AGPLv3-blue.svg)](https://raw.githubusercontent.com/GrooveStomp/gsnes/master/LICENSE) [![OLC-3 license](https://img.shields.io/badge/License-OLC&dash;3-blue.svg)](https://raw.githubusercontent.com/GrooveStomp/gsnes/master/LICENSE-OLC-3)

This NES emulator is based heavily off of the work done by [OneLoneCoder](https://github.com/OneLoneCoder/olcNES) ie., [javidx9](https://www.youtube.com/watch?v=F8kx56OZQhg).
I have written this emulator in C11 instead of the source C++17 used by javidx9.

## License
While this software is licensed under AGPLv3, this software _also_ retains the original license provided by OneLoneCoder.
Note that AGPLv3 is a much more _strict_ license than the OLC-3 license used by javidx9.

# Development
## Requirements
- make
- gcc
- sdl2
- doxygen (For documentation generation)

This is developed for Linux and no effort has been made to support it elsewhere.

## Building
There are four targets in the `Makefile`:
- `clean`
- `debug`
- `release`
- `docs`

The default target is `release`.
`release` builds `gstxt` at `release/gstxt`.
`debug` builds `gstxt` at `debug/gsxtxt`.
`docs` builds the documentation with Doxygen.

## Using
For now the emulator is not configurable outside of modifying source directly. The NES rom to load is hardcoded into main.c.

# Screenshots
![NES Test](/docs/screenshots/gsnes-2019-12-03.01.png?raw=true "NES Test")
![Donkey Kong](/docs/screenshots/gsnes-2019-12-03.06.png?raw=true "Donkey Kong")
![Ice Climber](/docs/screenshots/gsnes-2019-12-03.07.png?raw=true "Ice Climber")
\ No newline at end of file

A docs/screenshots/gsnes-2019-12-03.01.png => docs/screenshots/gsnes-2019-12-03.01.png +0 -0
A docs/screenshots/gsnes-2019-12-03.06.png => docs/screenshots/gsnes-2019-12-03.06.png +0 -0
A docs/screenshots/gsnes-2019-12-03.07.png => docs/screenshots/gsnes-2019-12-03.07.png +0 -0