Skip to content

Commit

Permalink
Update WSL install pages and finalise all other installation pages
Browse files Browse the repository at this point in the history
  • Loading branch information
omckeon committed Jul 14, 2024
1 parent e3f03d0 commit c19f6a3
Show file tree
Hide file tree
Showing 34 changed files with 315 additions and 142 deletions.
Binary file added public/gifs/windows/install-git-bash.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/gifs/windows/install-msys.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/gifs/windows/install-skm-git-bash.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/gifs/windows/install-vscode.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/gifs/windows/install-wsl.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/gifs/windows/msys-global-install.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/gifs/windows/msys-skm-install.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/gifs/windows/wsl-git-curl.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/gifs/windows/wsl-install-global.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/gifs/windows/wsl-skm-install.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/gifs/windows/wsl-terminal copy.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/gifs/windows/wsl-terminal.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
26 changes: 26 additions & 0 deletions src/content/docs/installation/Linux/step-3.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,29 @@ can download and install Visual Studio Code to use as a source code editor.
```

![Installing Visual Studio Code on Ubuntu](/gifs/linux/install-vsc.gif)

4. In Visual Studio Code you should install the following extensions:

For C#:

- [C#](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csharp)
- [C# Dev Kit](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csdevkit)
- [Intellicode for C# Dev Kit](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.vscodeintellicode-csharp)

You can do this from the command line by executing:

```shell
code --install-extension ms-dotnettools.csharp
code --install-extension ms-dotnettools.csdevkit
code --install-extension ms-dotnettools.vscodeintellicode-csharp
```

For C++:

- [C++ Extension Pack](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools-extension-pack)

You can do this from the command line by executing:

```shell
code --install-extension ms-vscode.cpptools-extension-pack
```
4 changes: 2 additions & 2 deletions src/content/docs/installation/MacOS/step-3.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Visual Studio Code, also commonly known as *VS Code* or just *Code*, is a powerf

3. In Visual Studio Code you should install the following extensions:

For C#:
For C#:

- [C#](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csharp)
- [C# Dev Kit](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csdevkit)
Expand All @@ -32,7 +32,7 @@ Visual Studio Code, also commonly known as *VS Code* or just *Code*, is a powerf
code --install-extension ms-dotnettools.vscodeintellicode-csharp
```

For C++:
For C++:

- [C++ Extension Pack](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools-extension-pack)

Expand Down
8 changes: 4 additions & 4 deletions src/content/docs/installation/Windows (MSYS2)/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,22 +14,22 @@ import { LinkCard, CardGrid } from "@astrojs/starlight/components";
<LinkCard
title="Install MSYS2 and Command Line Tools"
description="Step 1"
href="/installation/windows/mingw/step-1/"
href="/installation/windows-msys2/step-1/"
/>
<LinkCard
title="Install SplashKit"
description="Step 2"
href="/installation/windows/mingw/step-2/"
href="/installation/windows-msys2/step-2/"
/>
<LinkCard
title="Install Visual Studio Code"
description="Step 3"
href="/installation/windows/mingw/step-3/"
href="/installation/windows-msys2/step-3/"
/>
<LinkCard
title="Install Language Specific Tools"
description="Step 4"
href="/installation/windows/mingw/step-4/"
href="/installation/windows-msys2/step-4/"
/>
</CardGrid >

Expand Down
29 changes: 8 additions & 21 deletions src/content/docs/installation/Windows (MSYS2)/languages/dotnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,30 +6,17 @@ sidebar:
class: windows

---
Installing .NET on Windows is necessary because it provides the runtime environment and libraries required to run applications developed using the .NET framework.
To get programming with C#, you can install the Dotnet Core tools.

## Steps

1. Open an MSYS2 terminal
1. Run the following command:

```shell
pacman -S mingw-w64-{x86_64,i686}-gcc mingw-w64-{i686,x86_64}-gdb
```

![install-gpp-msys](/gifs/windows/install-gpp-msys.gif)
For coding in C#, you will need to install the `.NET` SDK which will allow you to use the *dotnet* terminal command to create, build, and run your C# project code.

1. Go to the [dotnet core](https://www.microsoft.com/net/core) page.

Select `windows`, `command line/other` then download the `.net core sdk`.

![8](/gifs/windows/8.gif)
## Steps

1. Run the installer and continue through the install wizard with default values.
1. Download the latest version of the .NET SDK for Windows from the official .NET website: [dotnet.microsoft.com/download](https://dotnet.microsoft.com/download)

![9](/gifs/windows/9.gif)
2. Run the downloaded installer and follow on-screen instructions.

1. Install the C# extension in Visual Studio Code.
3. Restart your terminal, and run the following command to check it is installed:

The C# extension will give you a great code formatter, Intellisense and OmniSharp. Open the extensions panel in the left of Visual Studio Code, and search for the extension `C#`, install the one by Microsoft.
```shell
dotnet --version
```
4 changes: 2 additions & 2 deletions src/content/docs/installation/Windows (MSYS2)/step-3.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Visual Studio Code, also commonly known as *VS Code* or just *Code*, is a powerf

3. In Visual Studio Code you should install the following extensions:

For C#:
For C#:

- [C#](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csharp)
- [C# Dev Kit](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csdevkit)
Expand All @@ -30,7 +30,7 @@ Visual Studio Code, also commonly known as *VS Code* or just *Code*, is a powerf
code --install-extension ms-dotnettools.vscodeintellicode-csharp
```

For C++:
For C++:

- [C++ Extension Pack](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools-extension-pack)

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/installation/Windows (MSYS2)/step-4.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ sidebar:
SplashKit works with a number of programming languages. Each of these has its own set of tools you will need to install.
/installation/windows/mingw/

- For C#, install the [Dotnet core](/installation/windows/mingw/languages/dotnet/) tools.
- For C#, install the [Dotnet core](/installation/windows-msys2/languages/dotnet/) tools.
- For C++, you're _already_ ready to go.

## What's next?
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,21 +14,31 @@ sidebar:
attrs:
class: windows
---
To get SplashKit installed on Windows, follow the two steps:
To get SplashKit installed on Windows, follow the four steps:

import { LinkCard, CardGrid } from "@astrojs/starlight/components";

<CardGrid>
<LinkCard
title="Install the WSL"
description="Step 1"
href="/installation/windows/wsl/step-1/"
/>
<LinkCard
title="Install SplashKit SDK"
description="Step 2"
href="/installation/windows/wsl/step-2/"
/>
<LinkCard
title="Install WSL and Command Line Tools"
description="Step 1"
href="/installation/windows-wsl/step-1/"
/>
<LinkCard
title="Install SplashKit"
description="Step 2"
href="/installation/windows-wsl/step-2/"
/>
<LinkCard
title="Install Visual Studio Code"
description="Step 3"
href="/installation/windows-wsl/step-3/"
/>
<LinkCard
title="Install Language Specific Tools"
description="Step 4"
href="/installation/windows-wsl/step-4/"
/>
</CardGrid >

Once you have all of these steps complete you should be setup and ready to
Expand Down
21 changes: 21 additions & 0 deletions src/content/docs/installation/Windows (WSL)/languages/dotnet.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: Installing the .NET Core SDK on Windows
sidebar:
hidden: true
attrs:
class: windows
---

For coding in C#, you will need to install the `.NET` SDK which will allow you to use the *dotnet* terminal command to create, build, and run your C# project code.

## Steps

1. Download the latest version of the .NET SDK for macOS from the official .NET website: [dotnet.microsoft.com/download](https://dotnet.microsoft.com/download)

2. Run the downloaded installer and follow on-screen instructions.

3. Restart your terminal, and run the following command to check it is installed:

```shell
dotnet --version
```
116 changes: 116 additions & 0 deletions src/content/docs/installation/Windows (WSL)/step-1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
---
title: Install WSL and Command Line Tools
sidebar:
label: 1. WSL and Command Line Tools
attrs:
class: windows
---

## Install WSL (Ubuntu)

Windows Subsystem for Linux (WSL) is a feature of Windows that allows you to run a Linux environment on your Windows machine, without the need for a separate virtual machine or dual booting.

### Method 1: Command Line (Recommended)

You can install both WSL and Ubuntu from the command-line using the following steps that have been adapted from the instructions provided in the official Microsoft documentation: [Install Windows Subsystem for Linux (WSL)](https://learn.microsoft.com/en-us/windows/wsl/install). This is the recommended method.

Open Terminal, PowerShell or Windows Command Prompt in *administrator mode* by right-clicking and selecting "Run as administrator", then copy and paste the following command to install WSL and Ubuntu:

```bash
wsl --install
```

![Gif showing WSL terminal running wsl --install commands](/gifs/windows/wsl-terminal.gif)

### Method 2: Microsoft Store (Alternative)

Alternatively, you can install WSL (and Ubuntu) directly from the Microsoft Store if you have this on your Windows computer.

To do this, search "WSL" in the Microsoft Store app (as shown below), or [click this link](https://apps.microsoft.com/store/detail/9P9TQF7MRM4R).

![Gif showing WSL being installed from Microsoft store](/gifs/windows/install-wsl.gif)

You will also need to download **Ubuntu** from the Microsoft Store. Search "Ubuntu" in the Microsoft Store app, or [click this link](https://apps.microsoft.com/store/detail/9PDXGNCFSCZV).

### Create Ubuntu User Account

Firstly, you need to **Restart** your computer if you haven't done so already.

A terminal window installing Ubuntu should pop up automatically, otherwise open the WSL or Ubuntu app for this window to open.

When prompted, enter your new UNIX username and password.
For example, with the username "**default-user**", your terminal would look like this:

![Image showing WSL terminal with ubuntu user account set up](/images/installation/windows/terminal-ubuntu-user-account.png)

You can see in the image above where the "**default-user**" username was first entered (shown in the pink box), and the same username being used with the terminal prompt (shown in the orange box).

:::tip[Troubleshooting tip:]
If you have issues installing the WSL with Ubuntu, you can reset the installation using the following command:

```bash
wsl --unregister Ubuntu
```

Then run the installation command again:

```bash
wsl --install
```

And lastly, search for `Ubuntu` to open the Ubuntu terminal, which will allow you to create the user account, as mentioned above.
:::

WSL is now setup and ready to use!

### Configure 'Windows Terminal'

Note: This step is *optional*.

If you want to be able to have your 'Windows **Terminal**' app automatically open with WSL, you can change the *Default profile* to use WSL (with Ubuntu) using the steps below:

Firstly, open the Terminal app, and click the drop-down arrow at the top of the window (shown in the green box in the image below), then click on "Settings" (shown in the orange box):

![Image showing Terminal App with how to open settings](/images/installation/windows/windows-terminal-settings.png)

Next, click on the drop-down menu within the *Default profile* section and select either of the **Ubuntu** profiles. *If you're unsure, select the one with the Linux penguin icon* (shown in the pink box):

![Image showing Terminal App with how to change default profile in settings](/images/installation/windows/windows-terminal-default-profile.png)

Click **Save**. (Don't forget this!)

Now your Terminal app will automatically use the WSL/Ubuntu command line when you open it.

:::note
Don't worry if you have different profiles in your Settings, as long as you can see at least one profile that has "Ubuntu" in the name (if you are using the default setup).
:::

:::tip[Pin it!]
To make it easier to open each time, you can pin your Terminal to the Taskbar.

- Open the Terminal App.
- Right-click on the Terminal App icon in the taskbar (shown in the orange box in the image below).
- Select "Pin to taskbar" (shown in the pink box):

![Image showing Terminal App pinning to taskbar](/images/installation/windows/terminal-pin-taskbar.png)
:::

## Install Command Line Tools

To install SplashKit on WSL, you will firstly need to install the `git`, `curl`, and `clang` tools using the `apt` command, which works with Ubuntu's **A**dvanced **P**ackaging **T**ool.

Open your WSL Terminal. You can do this by using the Windows Terminal app if you followed the steps above, by searching for "WSL" in the Windows Start menu and then select the **WSL** App, or by using the app for the Linux distribution you installed, such as **Ubuntu**, which is installed by default.

Update the package lists by running the following command in your **WSL Terminal**:

```shell
sudo apt update
```

Next, install the `git`, `curl` and `clang` tools by running the following command:

```shell
sudo apt install git curl clang
```

![Gif showing command above being run in WSL Terminal](/gifs/windows/wsl-git-curl.gif)
44 changes: 44 additions & 0 deletions src/content/docs/installation/Windows (WSL)/step-2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
title: Install SplashKit
sidebar:
label: 2. SplashKit
attrs:
class: windows
---

Once you have WSL installed, you can install the SplashKit library:

## Steps

1. Open up a WSL/Ubuntu terminal.

2. Install the SplashKit Manager by copy/pasting the command below into your terminal and press enter.

```shell
bash <(curl -s https://raw.githubusercontent.com/splashkit/skm/master/install-scripts/skm-install.sh)
```

3. Restart the terminal and execute `skm` to test it was successfully installed.

```shell
skm
```

You should see the following messages:

```shell
SplashKit is installed successfully!
Missing skm command. For help use 'skm help'
```

4. Run the following command to install the necessary dependencies and compile splashkit.

```shell
skm linux install
```

5. Run the following command to install splashkit globally.

```shell
skm global install
```
Loading

0 comments on commit c19f6a3

Please sign in to comment.