git.y1.nz

commit aebc11744c53c7ec7007c0184dab98eac708fc43
parent 2b263937da9d89c105ac7b36b057ac635dbd1386
Author: Lior Halphon <LIJI32@gmail.com>
Date:   Sat, 27 Feb 2021 15:37:40 +0200

Update readme

Diffstat:
M
README.md
6
++++--

1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
@@ -51,6 +51,8 @@ On Windows, SameBoy also requires:
 
 To compile, simply run `make`. The targets are `cocoa` (Default for macOS), `sdl` (Default for everything else), `libretro`, `bootroms` and `tester`. You may also specify `CONF=debug` (default), `CONF=release`, `CONF=native_release` or `CONF=fat_release`  to control optimization, symbols and multi-architectures. `native_release` is faster than `release`, but is optimized to the host's CPU and therefore is not portable. `fat_release` is exclusive to macOS and builds x86-64 and ARM64 fat binaries; this requires using a recent enough `clang` and macOS SDK using `xcode-select`, or setting them explicitly with `CC=` and `SYSROOT=`, respectively. All other configurations will build to your host architecture. You may set `BOOTROMS_DIR=...` to a directory containing precompiled boot ROM files, otherwise the build system will compile and use SameBoy's own boot ROMs.
 
-By default, the SDL port will look for resource files with a path relative to executable. If you are packaging SameBoy, you may wish to override this by setting the `DATA_DIR` variable during compilation to the target path of the directory containing all files (apart from the executable, that's not necessary) from the `build/bin/SDL` directory in the source tree. Make sure the variable ends with a `/` character.
+The SDL port will look for resource files with a path relative to executable and inside the directory specified by the `DATA_DIR` variable. If you are packaging SameBoy, you may wish to override this by setting the `DATA_DIR` variable during compilation to the target path of the directory containing all files (apart from the executable, that's not necessary) from the `build/bin/SDL` directory in the source tree. Make sure the variable ends with a `/` character. On FreeDesktop environments, `DATA_DIR` will default to `/usr/local/share/sameboy/`. `PREFIX` and `DESTDIR` follow their standard usage and default to an empty string an `/usr/local`, respectively
 
-SameBoy is compiled and tested on macOS and Ubuntu.
+Linux, BSD, and other FreeDesktop users can run `sudo make install` to install SameBoy as both a GUI app and a command line tool.
+
+SameBoy is compiled and tested on macOS, Ubuntu and 64-bit Windows 10.

This webpage is intended to be an accessible preview of this repository. To get a fuller picture, clone it and use the git CLI.