86Box/README.md

59 lines
2.7 KiB
Markdown
Raw Normal View History

2017-10-09 18:22:45 -04:00
86Box
=====
2020-08-12 11:33:30 -04:00
**86Box** is an IBM PC system emulator that specializes in running old
operating systems and software designed for IBM PC systems and compatibles
from 1981 through fairly recent system designs based on the PCI bus.
2016-06-27 17:04:15 -04:00
2020-06-23 14:11:53 -04:00
86Box is released under the GNU General Public License, version 2 or later.
For more information, see the `COPYING` file.
2016-06-27 17:04:15 -04:00
The project maintainer is OBattler.
2018-10-13 16:47:28 -04:00
If you need a configuration manager for 86Box, use the [86Box Manager](https://github.com/86Box/86BoxManager), our
officially endorsed 86Box configuration manager, developed by Overdoze (daviunic).
2018-10-13 16:47:28 -04:00
2017-10-09 18:22:45 -04:00
Community
---------
We operate an IRC channel and a Discord server for discussing anything related
to retro computing and, of course, 86Box. We look forward to hearing from you!
2018-08-29 09:39:48 -04:00
[![Visit our IRC channel](https://kiwiirc.com/buttons/irc.ringoflightning.net/softhistory.png)](https://kiwiirc.com/client/irc.ringoflightning.net/?nick=86box|?#softhistory)
[![Visit our Discord server](https://discordapp.com/api/guilds/262614059009048590/embed.png)](https://discord.gg/QXK9XTv)
Getting started
---------------
See [our documentation](https://86box.readthedocs.io/en/latest/index.html) for an overview of the emulator's features and user interface.
2017-10-09 18:22:45 -04:00
Building
--------
2020-04-17 18:10:24 -04:00
See the [build guide](doc/build.md).
2017-10-09 18:22:45 -04:00
2020-03-26 06:50:18 -04:00
Automatic builds
2017-10-09 18:22:45 -04:00
--------------
For your convenience, we compile a number of 86Box builds per revision on our
Jenkins instance.
2019-10-22 15:00:02 -04:00
| Regular | Debug | Optimized | Experimental |
|:-------:|:-----:|:---------:|:------------:|
|[![Build Status](http://ci.86box.net/job/86Box/badge/icon)](http://ci.86box.net/job/86Box)|[![Build Status](http://ci.86box.net/job/86Box-Debug/badge/icon)](http://ci.86box.net/job/86Box-Debug)|[![Build Status](http://ci.86box.net/job/86Box-Optimized/badge/icon)](http://ci.86box.net/job/86Box-Optimized)|[![Build Status](http://ci.86box.net/job/86Box-Dev/badge/icon)](http://ci.86box.net/job/86Box-Dev)
2017-10-09 18:22:45 -04:00
### Legend
* **Regular** builds are compiled using the settings in the building guide
above. Use these if you don't know which build to use.
2019-10-22 15:00:02 -04:00
* **Debug** builds are same as regular builds but include debug symbols.
If you don't need them, you don't need to use this build.
2017-10-09 18:22:45 -04:00
* **Optimized** builds have the same feature set as regular builds, but are
optimized for every modern Intel and AMD processor architecture, which might
improve the emulator's performance in certain scenarios.
* **Experimental (Dev)** builds are similar to regular builds but are compiled
with certain unfinished features enabled. These builds are not optimized for maximum performance.
2018-02-03 11:56:07 -05:00
Donations
---------
We do not charge you for the emulator but donations are still welcome:
2020-03-10 16:41:07 -04:00
https://paypal.me/86Box.
2020-07-06 20:37:35 -04:00
You can now also support the project on Patreon:
2020-07-06 20:37:35 -04:00
https://www.patreon.com/86box.