diff --git a/.github/workflows/c-cpp.yml b/.github/workflows/c-cpp.yml new file mode 100644 index 0000000..efc3e59 --- /dev/null +++ b/.github/workflows/c-cpp.yml @@ -0,0 +1,19 @@ +name: C/C++ CI + +on: + push: + branches: [ "main" ] + pull_request: + branches: [ "main" ] + +jobs: + build: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + - name: Install SDL2 + run: sudo apt-get install -y libsdl2-dev + - name: make + run: make diff --git a/README.md b/README.md new file mode 100644 index 0000000..9f867b7 --- /dev/null +++ b/README.md @@ -0,0 +1,50 @@ +# Fembng + +Fembng is a project that allows you to generate and view images with a rainbow gradient effect (for now because i'm to lazy) + +## Installation + +Follow these steps to install and run the Fembng project: + +### Prerequisites + +- Make sure you have `gcc` and `sdl2` installed. + +### Clone the Repository + +```bash +git clone https://github.com/MignonPetitXelow/Fembng.git ; cd Fembng +``` + +### Build the Project + +```bash +make +``` +### Run Fembng + +To generate an image: +```bash +./bin/fembng -w -h -o +``` + +Example: +```bash +./bin/fembng -w 800 -h 600 -o output +``` + +### Run Fembng Viewer + +To view a generated image: +```bash +./bin/fembngapp +``` + +Example: +```bash +./bin/fembngapp output.femboy +``` + +### Contributing + +Feel free to contribute to the project by opening issues or creating pull requests.