doc: move usage info to USAGE.md

This commit is contained in:
bnnm 2021-09-11 17:19:10 +02:00
parent d1c78d18c0
commit 6bf78f6b17
5 changed files with 1043 additions and 1025 deletions

View File

@ -224,6 +224,7 @@ ifeq ($(TARGET_OS),Windows_NT)
BIN_FILE = vgmstream-$(VGMSTREAM_VERSION)-win.zip BIN_FILE = vgmstream-$(VGMSTREAM_VERSION)-win.zip
ZIP_FILES = COPYING ZIP_FILES = COPYING
ZIP_FILES += README.md ZIP_FILES += README.md
ZIP_FILES += doc/USAGE.md
ZIP_FILES += cli/test.exe ZIP_FILES += cli/test.exe
ZIP_FILES += winamp/in_vgmstream.dll ZIP_FILES += winamp/in_vgmstream.dll
ZIP_FILES += xmplay/xmp-vgmstream.dll ZIP_FILES += xmplay/xmp-vgmstream.dll
@ -235,6 +236,7 @@ else
BIN_FILE = vgmstream-$(VGMSTREAM_VERSION)-bin.zip BIN_FILE = vgmstream-$(VGMSTREAM_VERSION)-bin.zip
ZIP_FILES = COPYING ZIP_FILES = COPYING
ZIP_FILES += README.md ZIP_FILES += README.md
ZIP_FILES += doc/USAGE.md
ZIP_FILES += cli/vgmstream-cli ZIP_FILES += cli/vgmstream-cli
ZIP_FILES_AO = cli/vgmstream123 ZIP_FILES_AO = cli/vgmstream123
endif endif

1046
README.md

File diff suppressed because it is too large Load Diff

View File

@ -68,7 +68,7 @@ $sdk = "10.0"
``` ```
It's also possible to call MSBuild and pass those values from the CMD, see foobar section for an example. It's also possible to call MSBuild and pass those values from the CMD, see foobar section for an example.
Once finished resulting binaries are in the *./Release* folder. Remember you need to copy extra `.dll` to run them (see [README.md](../README.md)). Once finished resulting binaries are in the *./Release* folder. Remember you need to copy extra `.dll` to run them (see [USAGE.md](USAGE.md)).
**For GCC/CLang**: there are basic Makefiles that work like usual with *make* (like `make vgmstream_cli EXTRA_CFLAGS="-DVGM_DEBUG_OUTPUT`). Artifacts are usually in their subdir (*./cli*, *./winamp*, etc). **For GCC/CLang**: there are basic Makefiles that work like usual with *make* (like `make vgmstream_cli EXTRA_CFLAGS="-DVGM_DEBUG_OUTPUT`). Artifacts are usually in their subdir (*./cli*, *./winamp*, etc).

1016
doc/USAGE.md Normal file

File diff suppressed because it is too large Load Diff

View File

@ -183,6 +183,7 @@ $fb2kFiles = @(
"ext_libs/libspeex/*.dll", "ext_libs/libspeex/*.dll",
"$configuration/foo_input_vgmstream.dll", "$configuration/foo_input_vgmstream.dll",
"README.md" "README.md"
"doc/USAGE.md"
) )
$cliFiles = @( $cliFiles = @(
@ -193,6 +194,7 @@ $cliFiles = @(
"$configuration/xmp-vgmstream.dll", "$configuration/xmp-vgmstream.dll",
"COPYING", "COPYING",
"README.md" "README.md"
"doc/USAGE.md"
) )
$fb2kPdbFiles = @( $fb2kPdbFiles = @(