Make MD docs comply with markdownlint
This commit is contained in:
krcroft
Patryk Obara
parent
312a763509
commit
a852fe3eab
5 changed files with 110 additions and 98 deletions
58
README.md
58
README.md
|
|
@ -1,7 +1,8 @@
|
|||
# dosbox-staging
|
||||
[](https://github.com/dreamer/dosbox-staging/actions?query=workflow%3A%22Linux+builds%22)
|
||||
[](https://github.com/dreamer/dosbox-staging/actions?query=workflow%3A%22Windows+builds%22)
|
||||
[](https://github.com/dreamer/dosbox-staging/actions?query=workflow%3A%22macOS+builds%22)
|
||||
|
||||
[](https://github.com/dreamer/dosbox-staging/actions?query=workflow%3A%22Linux+builds%22)
|
||||
[](https://github.com/dreamer/dosbox-staging/actions?query=workflow%3A%22Windows+builds%22)
|
||||
[](https://github.com/dreamer/dosbox-staging/actions?query=workflow%3A%22macOS+builds%22)
|
||||
|
||||
This repository attempts to modernize the [DOSBox](https://www.dosbox.com/)
|
||||
project by using current development practices and tools, fixing issues, adding
|
||||
|
|
@ -9,8 +10,7 @@ features that better support today's systems, and sending patches upstream.
|
|||
Read more at
|
||||
[Vogons thread](https://www.vogons.org/viewtopic.php?p=790065#p790065).
|
||||
|
||||
|
||||
## Summary of differences compared to upstream:
|
||||
## Summary of differences compared to upstream
|
||||
|
||||
| | dosbox-staging | DOSBox
|
||||
|- |- |-
|
||||
|
|
@ -45,43 +45,41 @@ Codecs supported for CD-DA emulation:
|
|||
| **WAV** | Yes (built-in) | Yes - SDL\_sound 1.2 (internal)<sup>[6],＊</sup>
|
||||
| **AIFF** | No | Yes - SDL\_sound 1.2 (internal)<sup>[6],＊</sup>
|
||||
|
||||
<sup>＊ - SDL 1.2 is not actively maintained any more.</sup>
|
||||
<sup>† - 22.05 kHz, 44.1 kHz, 48 kHz; mono, stereo</sup>
|
||||
<sup>‡ - 44.1 kHz stereo only</sup>
|
||||
<sup>§ - SDL\_sound supports it, but the feature might be broken or DOSBox does not indicate support.</sup>
|
||||
<sup>＊- SDL 1.2 was last updated 2013-08-17 and SDL\_sound 2008-04-20</sup>\
|
||||
<sup>† - 22.05 kHz, 44.1 kHz, 48 kHz; mono, stereo</sup>\
|
||||
<sup>‡ - 44.1 kHz stereo only</sup>\
|
||||
<sup>§ - Broken or unsupported in either SDL\_sound or DOSBox</sup>
|
||||
|
||||
[5]:https://www.dosbox.com/wiki/MOUNT#Mounting_a_CUE.2FBIN-Pair_as_volume
|
||||
[6]:https://sourceforge.net/p/dosbox/code-0/HEAD/tree/dosbox/trunk/src/dos/cdrom_image.cpp#l536
|
||||
|
||||
|
||||
## Development snapshot builds
|
||||
|
||||
Pre-release builds can be downloaded from CI build artifacts. Go to
|
||||
Pre-release builds can be downloaded from CI build artifacts. Go to
|
||||
[Linux](https://github.com/dreamer/dosbox-staging/actions?query=workflow%3A%22Linux+builds%22+is%3Asuccess)
|
||||
or
|
||||
[Windows](https://github.com/dreamer/dosbox-staging/actions?query=workflow%3A%22Windows+builds%22+is%3Asuccess),
|
||||
select a build you are interested in, click "**Artifacts**" button (in the top
|
||||
right), and download the package.
|
||||
|
||||
## [Linux](https://github.com/dreamer/dosbox-staging/actions?query=workflow%3A%22Linux+builds%22+is%3Asuccess)
|
||||
### [Linux](https://github.com/dreamer/dosbox-staging/actions?query=workflow%3A%22Linux+builds%22+is%3Asuccess)
|
||||
|
||||
Snapshots are dynamically-linked x86\_64 builds, you'll need additional
|
||||
packages installed via your package manager.
|
||||
|
||||
#### Fedora
|
||||
|
||||
$ sudo dnf install libpng SDL2 SDL2_net opusfile
|
||||
sudo dnf install libpng SDL2 SDL2_net opusfile
|
||||
|
||||
#### Debian, Ubuntu
|
||||
|
||||
$ sudo apt install libpng16-16 libsdl2-2.0 libsdl2-net-2.0 libopusfile0
|
||||
sudo apt install libpng16-16 libsdl2-2.0 libsdl2-net-2.0 libopusfile0
|
||||
|
||||
#### Arch, Manjaro
|
||||
|
||||
$ sudo pacman -S libpng sdl2 sdl2_net opusfile
|
||||
sudo pacman -S libpng sdl2 sdl2_net opusfile
|
||||
|
||||
|
||||
## [Windows](https://github.com/dreamer/dosbox-staging/actions?query=workflow%3A%22Windows+builds%22+is%3Asuccess)
|
||||
### [Windows](https://github.com/dreamer/dosbox-staging/actions?query=workflow%3A%22Windows+builds%22+is%3Asuccess)
|
||||
|
||||
A dosbox.exe file in a snapshot package is not signed, therefore Windows 10
|
||||
might prevent the program from starting.
|
||||
|
|
@ -94,11 +92,10 @@ unrecognised app from starting", you have two options to dismiss it:
|
|||
|
||||
Windows packages are built for "x86" architecture (in practice it means i686).
|
||||
|
||||
## macOS
|
||||
### macOS
|
||||
|
||||
macOS snapshots are not available at the moment.
|
||||
|
||||
|
||||
## Build instructions
|
||||
|
||||
### Linux, macOS, MSYS2, MinGW, other OSes
|
||||
|
|
@ -107,11 +104,13 @@ Read [INSTALL](INSTALL) file for a general summary about dependencies and
|
|||
configure options. Read [build.md](scripts/build.md) for the comprehensive
|
||||
compilation guide.
|
||||
|
||||
$ git clone https://github.com/dreamer/dosbox-staging.git
|
||||
$ cd dosbox-staging
|
||||
$ ./autogen.sh
|
||||
$ ./configure
|
||||
$ make
|
||||
``` shell
|
||||
git clone https://github.com/dreamer/dosbox-staging.git
|
||||
cd dosbox-staging
|
||||
./autogen.sh
|
||||
./configure
|
||||
make
|
||||
```
|
||||
|
||||
You can also use a helper script [`./scripts/build.sh`](scripts/build.sh),
|
||||
that performs builds for many useful scenarios (LTO, FDO, sanitizer builds,
|
||||
|
|
@ -123,15 +122,16 @@ First, you need to setup [vcpkg](https://github.com/microsoft/vcpkg) to
|
|||
install build dependencies. Once vcpkg is installed and bootstrapped, open
|
||||
PowerShell, and run:
|
||||
|
||||
PS> .\vcpkg integrate install
|
||||
PS> .\vcpkg install libpng sdl2 sdl2-net opusfile
|
||||
``` powershell
|
||||
PS:\> .\vcpkg integrate install
|
||||
PS:\> .\vcpkg install libpng sdl2 sdl2-net opusfile
|
||||
```
|
||||
|
||||
These two steps will ensure that MSVC finds and links all dependencies.
|
||||
|
||||
Start Visual Studio, open file: `vs\dosbox.sln` and build all projects
|
||||
(Ctrl+Shift+B).
|
||||
|
||||
|
||||
## Interop with SVN
|
||||
|
||||
This repository is (deliberately) NOT git-svn compatible, this is a pure
|
||||
|
|
@ -156,4 +156,6 @@ Additionally, we attach some optional metadata to the commits imported from SVN
|
|||
in the form of [Git notes](https://git-scm.com/docs/git-notes). To fetch them,
|
||||
run:
|
||||
|
||||
$ git fetch origin "refs/notes/*:refs/notes/*"
|
||||
``` shell
|
||||
git fetch origin "refs/notes/*:refs/notes/*"
|
||||
```
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue