An open API service indexing awesome lists of open source software.

https://github.com/horizon-nth/fractalexplorer

Application to explore differents fractals
https://github.com/horizon-nth/fractalexplorer

application cpp fractal-rendering fractals glsl

Last synced: 4 months ago
JSON representation

Application to explore differents fractals

Awesome Lists containing this project

README

        

# FractalExplorer

[![Release](https://img.shields.io/badge/Release-v4.0-blueviolet)](https://github.com/Horizon-NTH/FractalExplorer/releases)
[![Language](https://img.shields.io/badge/Language-C%2B%2B-0052cf)](https://en.wikipedia.org/wiki/C++)
[![Licence](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)

## Introduction

**FractalExplorer** is an application that lets you explore
beautiful fractals like the [Mandelbrot set](https://en.wikipedia.org/wiki/Mandelbrot_set).

![Mandelbrot set](https://github.com/Horizon-NTH/FractalExplorer/blob/master/assets/screenshots/mandelbrot0.png)

> **Note**: If you want to see more image like this you can check
> the [gallery](https://github.com/Horizon-NTH/FractalExplorer/wiki/Gallery).

## Installation Instructions

> You can also simply install a pre-built version [here](https://github.com/Horizon-NTH/FractalExplorer/releases).

### Get Source Code

You first need to clone the [repository](https://github.com/Horizon-NTH/FractalExplorer). Make sure to
use [git](https://git-scm.com) and don't forget to include `--recurse-submodules` when cloning.

```bash
git clone https://github.com/Horizon-NTH/FractalExplorer --recurse-submodules
```

You will now able to choose between [script](#script-installation) or [manual](#manual-installation) installation

- ### Script Installation

Use the [`install.sh`](https://github.com/Horizon-NTH/FractalExplorer/blob/master/install.sh) script to compile the
executable. You can choose to erase build files by adding `-e` / `--erase`.

```bash
./install.sh --erase
```

- ### Manual Installation

#### Create Build Environment

Ensure you have [CMake](https://cmake.org/) installed. Generate the build environment using CMake.

```bash
cd FractalExplorer
mkdir build && cd build
cmake ..
```

#### Build

- ##### CMake

Build directly using CMake:

```bash
cmake --build .
```

This command will create all the executable in the main folder.

- ##### Microsoft Visual Studio

Alternatively, you can use [Microsoft Visual Studio](https://visualstudio.microsoft.com/) to launch the project and
build it. Open the `fractalexplorer.sln` file with Microsoft Visual Studio.

## Usage

To learn how to use this application, please refer to the [wiki](https://github.com/Horizon-NTH/FractalExplorer/wiki).

## Dependencies

- **HorizonGUI**

The code relies on [HorizonGUI](https://github.com/Horizon-NTH/HorizonGUI) for all the graphics-related functionality
of the application.

## License

[**FractalExplorer**](https://github.com/Horizon-NTH/FractalExplorer) is licensed under
the [MIT license](https://github.com/Horizon-NTH/FractalExplorer/blob/master/LICENSE).