Skip to content

Commit

Permalink
Fix typos
Browse files Browse the repository at this point in the history
  • Loading branch information
Raytwo committed Aug 26, 2024
1 parent adafbdb commit db98da1
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion doc/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@
## Skyline

- [Skyline Plugins](./ch02-00-skyline-plugins.md)
- [Template](./ch02-01-template.md)
- [Analyzing the Template](./ch02-01-analyzing-template.md)
6 changes: 3 additions & 3 deletions doc/src/ch01-01-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ The first step is to install Rust. Considering the official book already does a
### Installing Git

Git is a version control system. It is used to manage your coding projects by taking "snapshots" of your code as key points in time, collaborate with other people, distribution and so on.
Git is a version control system. It is used to manage your coding projects by taking "snapshots" of your code at key points in time, collaborate with other people, distribute binaries and so on.
This book will not teach you how to use it, but it is important to have it on your system to follow the next steps smoothly.

Head over to [the official website](https://git-scm.com/downloads) and install the appropriate version for your operating system. The default settings are perfectly fine for our purpose, but feel free to tweak them if you are familiar with it!
Head over to [the official website](https://git-scm.com/downloads) and install the appropriate version for your operating system. The default settings are perfectly fine for our use case, but feel free to tweak them if you are familiar with it!

### Installing cargo-skyline

Cargo-skyline is a command-line interface tool used to facilitate compiling Rust code for the Nintendo Switch as well as listen to logging messages from your console.
Cargo-skyline is a command-line interface tool used to facilitate compiling Rust code for the Nintendo Switch as well as listening to logging messages from your console.

To install it, open a terminal and type the following command:
```console
Expand Down
4 changes: 2 additions & 2 deletions doc/src/ch01-02-hello-world.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ Using a terminal, navigate to the workspace you previously created during the In
```console
cargo skyline new hello_world
```
> The very first time you create a project with cargo-skyline in a directory, you will be prompted to download the source code for the Rust language. It is a necessary step to build Rust programs that are capable of using the Nintendo Switch features and should last between 3 and 10 minutes depending on your download speed.
> The very first time you create a project with cargo-skyline in a directory, you will be prompted to download the source code for the Rust language. It is a necessary step to build Rust programs that are capable of using the Nintendo Switch features and should take between 3 and 10 minutes depending on your download speed.
### Compiling

You've just create a new Skyline Plugin project, so let's go through the compilation steps.
You've just created a new Skyline Plugin project, so let's go through the compilation steps.

Before loading it through Cobalt, you must compile your plugin using cargo-skyline by entering the following command in the directory:

Expand Down
2 changes: 1 addition & 1 deletion doc/src/ch02-00-skyline-plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

This chapter covers concepts that are (mostly) specific to game modding and how they translate as Skyline plugins. You will be shown plugin templates documented examples to showcase the possibilities offered by the Skyline framework.

Cobalt specific concepts will be introduced in another chapter once you're familiar with Skyline as a whole.
Cobalt specific concepts will be introduced in a later chapter once you're familiar with Skyline as a whole.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Template
## Analyzing the Template

Let's start learning about Skyline by analyzing the project you've initialized in the previous chapter! If you check out the *lib.rs* file inside of your plugin's */src* directory, you'll be greeted with the following:
Let's start learning about Skyline by analyzing the project you've set up in the previous chapter! If you check out the *lib.rs* file inside of your plugin's */src* directory, you'll be greeted with the following:

```rust
#[skyline::main(name = "hello_world")]
Expand Down Expand Up @@ -36,7 +36,7 @@ Now, let's look at the inside of your ``entry point``, which has a single functi
println!("Hello from skyline plugin");
```

As the name might imply, ``println!`` is a [macro](https://doc.rust-lang.org/book/ch19-06-macros.html) (yes!) to print text and it stands for ``print line new.
As the name might imply, ``println!`` is a [macro](https://doc.rust-lang.org/book/ch19-06-macros.html) (yes!) to print text and it stands for ``print line new``.

You might be wondering where exactly text would be printed on a Nintendo Switch and the answer is: it depends.

Expand Down

0 comments on commit db98da1

Please sign in to comment.