Skip to content

Commit

Permalink
Update readme to be in Markdown (#24)
Browse files Browse the repository at this point in the history
* Updated readme to be in Markdown and removed a paragraph about binaries since the website is no longer operational

* Fix build error caused by change of readme filename

* Updated information about project's homepage
  • Loading branch information
TheMaxus authored May 10, 2021
1 parent f2d74d7 commit e98f63f
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 13 deletions.
20 changes: 8 additions & 12 deletions readme.txt → README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
About
=====
# DSOAL

This project is for a DirectSound DLL replacement. It implements the
DirectSound interfaces by translating the calls to OpenAL, and fools
Expand All @@ -16,11 +15,10 @@ Or more succinctly: it enables DirectSound3D surround sound and EAX for systems
without the requisite hardware.


Source Code
===========
## Source Code

To build the source, you will need CMake 2.6 or newer (you can get it from
<http://www.cmake.org/>). You can either use the CMake GUI, specifying the
To build the source, you will need [CMake](http://www.cmake.org/) 2.6 or newer.
You can either use the CMake GUI, specifying the
directories for the source and where the build files should go, or using one of
the command-line programs, for example by first making sure to be in an empty
directory where the build files will go (such as the provided build/ sub-
Expand All @@ -29,16 +27,14 @@ directory) and running cmake with the path to the source.
Once successfully built, it should have created dsound.dll.


Usage
=====
## Usage

Once built, copy dsound.dll to the same location as the desired application's
executable. You must also provide an OpenAL DLL in the same location, named as
dsoal-aldrv.dll, or else the DLL will fail to work. Some applications may need
to be configured to use DirectSound3D acceleration and EAX, but it otherwise
goes to work the next time the application is run.


Source releases, the Git repository, and Windows binaries for OpenAL Soft are
available at its homepage <http://kcat.strangesoft.net/openal.html>.
Instructions are also provided there.
Source releases and Windows binaries for OpenAL Soft are
available at its [homepage](https://openal-soft.org/).
Instructions are also provided there.
2 changes: 1 addition & 1 deletion appveyor.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ environment:
CFG: Release

after_build:
- 7z a ..\dsoal.zip "%APPVEYOR_BUILD_FOLDER%\build\%CFG%\dsound.dll" "%APPVEYOR_BUILD_FOLDER%\readme.txt" "%APPVEYOR_BUILD_FOLDER%\LICENSE"
- 7z a ..\dsoal.zip "%APPVEYOR_BUILD_FOLDER%\build\%CFG%\dsound.dll" "%APPVEYOR_BUILD_FOLDER%\README.md" "%APPVEYOR_BUILD_FOLDER%\LICENSE"

artifacts:
- path: dsoal.zip
Expand Down

0 comments on commit e98f63f

Please sign in to comment.