diff options
| -rw-r--r-- | README.txt | 49 |
1 files changed, 27 insertions, 22 deletions
diff --git a/README.txt b/README.txt index 9352322..f3ade5b 100644 --- a/README.txt +++ b/README.txt @@ -13,35 +13,40 @@ My goal with this project is: - NetBSD - FreeBSD - Windows + - OpenBSD + - Mac OSX (File loading issue???) The following platforms are planned with the reasons why they aren't yet: - - OpenBSD (Lack of c11 threads) - - Mac OSX (Need a virtual machine.) - - Haiku (Could work in theory, need to add a compile time option to - disable audio.) + - Haiku - Hurd (I'll fuckin do it for the memes, mark my words...) - - OpenIndiana (Same issue as Haiku) + - OpenIndiana 2. Make a fun, simple game. 3. Improve my coding skills. If you have any criticism of my code, go ahead and leave an issue! Pointing out mistakes is the only way I can learn. =============================================================================== Build: - Linux: - The intended way for linux is to build it into a flatpak. Here are the - steps: - 1. Install premake5 - 2. Run: `premake5 --prefix=/app --flatpak=true gmake2` - 3. Run: `flatpak-builder --repo=flatpak_repo --user --install --force-clean build-dir net.iotib.Pong.yml` - 4. Run: `flatpak build-bundle flatpak_repo net.iotib.Pong.flatpak net.iotib.Pong <version>` - 5. You should now be able to distribute it. - Unix/BSD: - If you decide to not use a flatpak on Linux, or you are using a BSD. - Here are the steps: - 1. Install premake5 - 2. Run: `premake5 --prefix=/dir/to/prefix gmake2` - 3. Run: `make -j$(nproc)` - 4. Run: `premake5 install` - 5. Go to your prefix, and you should see a Pong folder. Just run the launch.sh and you should be good to go. + Unix/POSIX: + 1. Install the following dependencies: + - Raylib - For Graphics Drawing + - GLFW3 - Raylib dependency + - SDL2 - SDL2_mixer dependency + - SDL2_mixer - For sound + - premake5 - To generate build files + - pkgconf (not pkg-config) + 2. Run `premake5 check_deps` to make sure you have all dependencies. + 3. Run `premake5 gmake2` + 4. Run `make` or `gmake` + 5. Run `premake5 install` to install it to the prefix. + Flatpak: + 1. Run `premake5 gmake2` + 2. Run `flatpak-builder --user --force-clean --install --repo=flatpak_repo build-dir net.iotib.Pong.yml` + 3. Generate a distributable file using: `flatpak build-bundle flatpak_repo net.iotib.Pong.flatpak net.iotib.Pong <version>` + 4. Once installed, you can run it using `flatpak run net.iotib.Pong` Windows: - PLACEHOLDER + 1. Install msys2 (https://www.msys2.org/) + 2. Follow the instructions from the unix section. + Mac OSX: + NOTE: There's a potential file loading issue. + 1. Install homebrew (https://brew.sh/) + 2. Follow the instructions from the unix section. =============================================================================== |