Skip to content
This repository has been archived by the owner on Jun 3, 2022. It is now read-only.

Commit

Permalink
Updated Readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Kilian BOTREL committed Apr 1, 2019
1 parent e6be400 commit b9257a5
Showing 1 changed file with 13 additions and 23 deletions.
36 changes: 13 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,42 +7,34 @@ This project's goal is to make a fractal visualizer.
Only works on **42-Paris Dumps** at the moment but should be portable on any **macOS X** in the near future.

Simply type command bellow in your shell :
```
$> make
```
`$> make`

## Usage
### Run the program

Once the program is compiled, run it with the following command line :
```
$> ./fractol 'Desired Fractal'
```
`$> ./fractol 'Desired Fractal'`

To get more informations on how the program works and how you can interact with it type :
```
$> ./fractol
```
`$> ./fractol`

To set everything up before running the visualizer with a graphic interface do :
```
$> fractol menu
```
`$> fractol menu`

### Fractal list

Every fractal bellow are handled by the program.

Name | Type | Multithread
--- | --- | ---
Mandelbrot | Complex | Yes
Julia | Complex | Yes
Burning Ship | Complex | Yes
Burning Julia | Complex | Yes
Sierpinski triangle | Space filling curve | No
Van Koch's snowfake | Auto-similar | No
Barnsley's fern | Random generation | No
Flower (Original) | Space filling and auto-similar | No
Mandelbrot | Complex | :heavy_check_mark:
Julia | Complex | :heavy_check_mark:
Burning Ship | Complex | :heavy_check_mark:
Burning Julia | Complex | :heavy_check_mark:
Sierpinski triangle | Space filling curve | :heavy_multiplication_x:
Van Koch's snowfake | Auto-similar | :heavy_multiplication_x:
Barnsley's fern | Random generation | :heavy_multiplication_x:
Flower (Original) | Space filling and auto-similar | :heavy_multiplication_x:

### Controls

Expand Down Expand Up @@ -74,8 +66,6 @@ Each following error is handled by the program leading to a complete memory free
* Audio file unavailable (*ERROR-CODE 6*)

Whenever one of these error occurs, the correct error message is displayed on the **standard output** and the whole program return an error code that you can retrieve by running :
```
$> echo $?
```
`$> echo $?`

## Screenshots

0 comments on commit b9257a5

Please sign in to comment.