Skip to content

Commit edd61aa

Browse files
authored
Merge pull request #294 from seb3s/patch-1
Patch 1 - fix documentation Thank you!
2 parents 6838ff7 + fc2cb83 commit edd61aa

File tree

4 files changed

+18
-18
lines changed

4 files changed

+18
-18
lines changed

.github/CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ excellent pull request:
158158
# Navigate to the newly cloned directory
159159
cd scenic
160160
# Assign the original repo to a remote called "upstream"
161-
git remote add upstream https://github.com/boydm/scenic
161+
git remote add upstream https://github.com/ScenicFramework/scenic
162162
```
163163

164164
2. If you cloned a while ago, get the latest changes from upstream, and update

guides/getting_started.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ mix archive.install hex scenic_new
2222
## Build the Basic App
2323

2424
First, navigate the command-line to the directory where you want to create your
25-
new Scenic app. Then run the following commands: (change `my_app` to the name
25+
new Scenic app. Then run the following commands: (change `my_app` to the name
2626
of your app...)
2727

2828
```bash
@@ -36,7 +36,7 @@ If you want to explore the more full-on example, then follow the instructions be
3636
## Build the Example App
3737

3838
First, navigate the command-line to the directory where you want to create your
39-
new Scenic app. Then run the following commands: (change `my_app` to the name
39+
new Scenic app. Then run the following commands: (change `my_app` to the name
4040
of your app...)
4141

4242
```bash
@@ -56,18 +56,18 @@ configurations should live in your app's config.exs file.
5656
import Config
5757

5858
# Configure the main viewport for the Scenic application
59-
config :my_app, :viewport, %{
59+
config :my_app, :viewport, [
6060
name: :main_viewport,
6161
size: {700, 600},
6262
default_scene: MyApp.Scene.Example,
6363
drivers: [
64-
%{
65-
module: Scenic.Driver.Glfw,
66-
name: :glfw,
67-
opts: [resizeable: false, title: "Example Application"],
68-
}
64+
[
65+
module: Scenic.Driver.Local,
66+
name: :local,
67+
window: [resizeable: false, title: "Example Application"],
68+
]
6969
]
70-
}
70+
]
7171

7272
Then use that config to start your supervisor with the `Scenic` supervisor.
7373

guides/overview_scene.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -105,18 +105,18 @@ configuration of a ViewPort from the config.exs file...
105105
import Config
106106

107107
# Configure the main viewport for the Scenic application
108-
config :my_app, :viewport, %{
108+
config :my_app, :viewport, [
109109
name: :main_viewport,
110110
size: {700, 600},
111111
default_scene: {MyApp.Scene.Example, :scene_init_data},
112112
drivers: [
113-
%{
114-
module: Scenic.Driver.Glfw,
115-
name: :glfw,
116-
opts: [resizeable: false, title: "Example Application"],
117-
}
113+
[
114+
module: Scenic.Driver.Local,
115+
name: :local,
116+
window: [resizeable: false, title: "Example Application"],
117+
]
118118
]
119-
}
119+
]
120120

121121
The line `default_scene: {MyApp.Scene.Example, :scene_init_data}`
122122
configures the ViewPort to always start the scene defined by the

guides/upgrading_to_v0.11.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@ Note that, in this example, we are holding the `Scene` variable inside the state
192192
```elixir
193193
defmodule MyDevice.Scene.Example do
194194
use Scenic.Scene
195-
import Primitives
195+
import Scenic.Primitives
196196

197197
def init(scene, _param, _opts) do
198198
graph = Scenic.Graph.build( font: :roboto )

0 commit comments

Comments
 (0)