Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Patch 1 - fix documentation #294

Merged
merged 6 commits into from
Nov 26, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ excellent pull request:
# Navigate to the newly cloned directory
cd scenic
# Assign the original repo to a remote called "upstream"
git remote add upstream https://github.com/boydm/scenic
git remote add upstream https://github.com/ScenicFramework/scenic
```

2. If you cloned a while ago, get the latest changes from upstream, and update
Expand Down
18 changes: 9 additions & 9 deletions guides/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ mix archive.install hex scenic_new
## Build the Basic App

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

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

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

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

# Configure the main viewport for the Scenic application
config :my_app, :viewport, %{
config :my_app, :viewport, [
name: :main_viewport,
size: {700, 600},
default_scene: MyApp.Scene.Example,
drivers: [
%{
module: Scenic.Driver.Glfw,
name: :glfw,
opts: [resizeable: false, title: "Example Application"],
}
[
module: Scenic.Driver.Local,
name: :local,
window: [resizeable: false, title: "Example Application"],
]
]
}
]

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

Expand Down
14 changes: 7 additions & 7 deletions guides/overview_scene.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,18 +105,18 @@ configuration of a ViewPort from the config.exs file...
import Config

# Configure the main viewport for the Scenic application
config :my_app, :viewport, %{
config :my_app, :viewport, [
name: :main_viewport,
size: {700, 600},
default_scene: {MyApp.Scene.Example, :scene_init_data},
drivers: [
%{
module: Scenic.Driver.Glfw,
name: :glfw,
opts: [resizeable: false, title: "Example Application"],
}
[
module: Scenic.Driver.Local,
name: :local,
window: [resizeable: false, title: "Example Application"],
]
]
}
]

The line `default_scene: {MyApp.Scene.Example, :scene_init_data}`
configures the ViewPort to always start the scene defined by the
Expand Down
2 changes: 1 addition & 1 deletion guides/upgrading_to_v0.11.md
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ Note that, in this example, we are holding the `Scene` variable inside the state
```elixir
defmodule MyDevice.Scene.Example do
use Scenic.Scene
import Primitives
import Scenic.Primitives

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