Skip to content

Commit 03ba52c

Browse files
committed
Added body to readme
1 parent 1c43233 commit 03ba52c

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,34 @@
11
# eclipse_simulator
2+
3+
Visualizers to show sun and moon positions, give a certain time and position on
4+
the earth. Two examples are present, using Gosu and Ruby2D.
5+
6+
To install the gosu and ruby2d gem you will also need the following libraries:
7+
* gosu (brew install gosu on macos)
8+
* sdl2 (brew install sdl2 on macos)
9+
* simple2d (`brew tap simple2d/tap; brew install simple2d` on macos)
10+
11+
After installing the gems, do `bundle install` an normal.
12+
13+
The green line is the horizon and will move up and down depending on the time
14+
of the year.
15+
16+
Default starting position on the earth is Grand Teton National Park, which
17+
will be in the path of totality for the 2017 Eclipse. Default time is the
18+
projected time of totality for that location.
19+
20+
You can move through time with the left and right arrows. By default, right
21+
arrow will move you 1 hour ahead, left will move you one hour behind. You can
22+
change the movement speed using the up and down arrows. Your current movement
23+
speed is shown in the window title bar.
24+
25+
The "r" key will set the time to be sunrise of the current day.
26+
27+
The "s" key will set the time to be sunset of the current day.
28+
Escape will exit.
29+
30+
You can change the position on earth by changing the value of `@coords`:
31+
Insert your preferred Lat/Long coordinates in decimal format.
32+
33+
You can also change the default start time by changing `@current_time`. You can
34+
also uses the SunCalc gem to set the time to be sunrise, sunset, mid-day, etc.

0 commit comments

Comments
 (0)