path: root/README.txt

██████╗  ██████╗ ███╗   ██╗ ██████╗ 
██╔══██╗██╔═══██╗████╗  ██║██╔════╝ 
██████╔╝██║   ██║██╔██╗ ██║██║  ███╗
██╔═══╝ ██║   ██║██║╚██╗██║██║   ██║
██║     ╚██████╔╝██║ ╚████║╚██████╔╝
╚═╝      ╚═════╝ ╚═╝  ╚═══╝ ╚═════╝ 
===============================================================================
Description:
This is a pong clone made in C using raylib as the main back bone of the code.
My goal with this project is:
    1. Support as many platforms as possible. At the current time these are:
        - Linux
        - NetBSD
        - FreeBSD
        - Windows
        - OpenBSD
        - Mac OSX (File loading issue???)
       The following platforms are planned with the reasons why they aren't yet:
        - Haiku
        - Hurd (I'll fuckin do it for the memes, mark my words...)
        - 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:
    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)
            - Mesa
        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:
        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.
===============================================================================