Skip to content

Commit

Permalink
Update documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
ttsiodras committed Jan 15, 2021
1 parent 777db9a commit 6806ef9
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 8 deletions.
10 changes: 7 additions & 3 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ COMPILE/INSTALL/RUN
Windows
-------
Windows users can download and run a pre-compiled Windows binary
[here](https://github.com/ttsiodras/MandelbrotSSE/releases/download/2.2/mandelSSE-win32-2.2.zip).
[here](https://github.com/ttsiodras/MandelbrotSSE/releases/download/2.3/mandelSSE-win32-2.3.zip).

After decompressing, you can simply execute either one of the two .bat
files. The 'autopilot' one zooms in a specific location, while the other
Expand Down Expand Up @@ -46,13 +46,17 @@ You can then simply...
$ src/mandelSSE
(Runs in autopilot in 1024x768 window, using XaoS)

$ src/mandelSSE -s -m 800 600
$ src/mandelSSE -s -m 1280 720
(Runs in mouse-driven SSE mode, in a 800x600 window)
(left-click zooms-in, right-click zooms out)

$ src/mandelSSE -x -m 800 600
$ src/mandelSSE -x -m 1280 720
(same as before, but in XaoS mode - much faster, esp during deep zooms)

For ultimate speed, disable the frame limiter (defaults to 60fps)

$ src/mandelSSE -x -m -f 0 1280 720

WHAT IS THIS, AGAIN?
====================

Expand Down
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ COMPILE/INSTALL/RUN
Windows
-------
Windows users can download and run a pre-compiled Windows binary
[here](https://github.com/ttsiodras/MandelbrotSSE/releases/download/2.2/mandelSSE-win32-2.2.zip).
[here](https://github.com/ttsiodras/MandelbrotSSE/releases/download/2.3/mandelSSE-win32-2.3.zip).

After decompressing, you can simply execute either one of the two .bat
files. The 'autopilot' one zooms in a specific location, while the other
Expand All @@ -27,8 +27,6 @@ Make sure you have libSDL installed - then...
$ ./configure
$ make

You can then simply...

$ src/mandelSSE -h

Usage: ./src/mandelSSE [-a] [-s|-x] [-h] [-f rate] [WIDTH HEIGHT]
Expand All @@ -46,13 +44,17 @@ You can then simply...
$ src/mandelSSE
(Runs in autopilot in 1024x768 window, using XaoS)

$ src/mandelSSE -s -m 800 600
$ src/mandelSSE -s -m 1280 720
(Runs in mouse-driven SSE mode, in a 800x600 window)
(left-click zooms-in, right-click zooms out)

$ src/mandelSSE -x -m 800 600
$ src/mandelSSE -x -m 1280 720
(same as before, but in XaoS mode - much faster, esp during deep zooms)

For ultimate speed, disable the frame limiter (defaults to 60fps)

$ src/mandelSSE -x -m -f 0 1280 720

WHAT IS THIS, AGAIN?
====================

Expand Down

0 comments on commit 6806ef9

Please sign in to comment.