README.md

cpp3ds [![Build Status](https://travis-ci.org/cpp3ds/cpp3ds.png?branch=master)](https://travis-ci.org/cpp3ds/cpp3ds)
======

Basic C++ gaming framework and library for Nintendo 3DS.

cpp3ds is essentially a barebones port of SFML with a parallel native 3ds emulator built on top of it. The goal is to completely abstract the developer from the hardware SDK and provide a nice object-oriented C++ framework for clean and easy coding. And the emulator is designed to provide a means of surface-level realtime debugging (with GDB or whatever you prefer).

Won't be stable and usable until v1.0

Installation
------------
Coming soon.

Documentation
-------------
Will be released with v1.0 stable

Requirements
------------
 
- DevkitARM
- ctrulib
- citro3d

For emulator:

- [SFML 2.3](http://www.sfml-dev.org/index.php)
- [Qt 5](https://qt-project.org/)
- OpenAL
- libvorbis

For unit tests:

- [Google Test](https://code.google.com/p/googletest/)

Credit and Thanks
-----------------
- [Laurent Gomila](https://github.com/LaurentGomila) and SFML team
- [smealum](https://github.com/smealum) - ctrulib
- [Lectem](https://github.com/Lectem) - some CMake stuff
- Everyone on EFNet #3dsdev
Update README 2014-02-12 21:12:29 -05:00			`cpp3ds [![Build Status](https://travis-ci.org/cpp3ds/cpp3ds.png?branch=master)](https://travis-ci.org/cpp3ds/cpp3ds)`
Initial commit 2014-01-29 11:55:03 -08:00			`======`

Full overhaul and SFML header inclusion 2015-05-15 15:08:42 -04:00			`Basic C++ gaming framework and library for Nintendo 3DS.`
Added credits 2014-02-01 00:45:04 -05:00
Full overhaul and SFML header inclusion 2015-05-15 15:08:42 -04:00			`cpp3ds is essentially a barebones port of SFML with a parallel native 3ds emulator built on top of it. The goal is to completely abstract the developer from the hardware SDK and provide a nice object-oriented C++ framework for clean and easy coding. And the emulator is designed to provide a means of surface-level realtime debugging (with GDB or whatever you prefer).`

			`Won't be stable and usable until v1.0`
Update project progress. 2014-02-16 22:55:59 -05:00
Update readme 2015-08-20 17:12:44 -04:00			`Installation`
			`------------`
			`Coming soon.`

Update README 2014-02-12 21:12:29 -05:00			`Documentation`
			`-------------`
Full overhaul and SFML header inclusion 2015-05-15 15:08:42 -04:00			`Will be released with v1.0 stable`
Update README 2014-02-12 21:12:29 -05:00
			`Requirements`
			`------------`

Full overhaul and SFML header inclusion 2015-05-15 15:08:42 -04:00			`- DevkitARM`
			`- ctrulib`
Add version to CIA build and update README 2016-05-30 03:58:56 -04:00			`- citro3d`
Update README 2014-02-12 21:12:29 -05:00
Rename simulator -> emulator 2014-05-25 23:19:21 -04:00			`For emulator:`
Added framework for 3DS simulator using GTK+ and SFML 2014-02-27 22:16:28 -05:00
Add version to CIA build and update README 2016-05-30 03:58:56 -04:00			`- [SFML 2.3](http://www.sfml-dev.org/index.php)`
Rename simulator -> emulator 2014-05-25 23:19:21 -04:00			`- [Qt 5](https://qt-project.org/)`
Add version to CIA build and update README 2016-05-30 03:58:56 -04:00			`- OpenAL`
			`- libvorbis`
Added framework for 3DS simulator using GTK+ and SFML 2014-02-27 22:16:28 -05:00
			`For unit tests:`
Update README 2014-02-12 21:12:29 -05:00
			`- [Google Test](https://code.google.com/p/googletest/)`

			`Credit and Thanks`
			`-----------------`
Update readme 2015-08-20 17:12:44 -04:00			`- [Laurent Gomila](https://github.com/LaurentGomila) and SFML team`
Full overhaul and SFML header inclusion 2015-05-15 15:08:42 -04:00			`- [smealum](https://github.com/smealum) - ctrulib`
Update readme 2015-08-20 17:12:44 -04:00			`- [Lectem](https://github.com/Lectem) - some CMake stuff`
			`- Everyone on EFNet #3dsdev`