fix typos and make install manual easier to read

vuelto-org · Jan 31, 2025 · 1af4afc · 1af4afc
1 parent 6000da1
commit 1af4afc
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 24 deletions.
diff --git a/README.md b/README.md
@@ -31,8 +31,7 @@ You need to have the following installed on your system:
 
 - 🖥️ A C compiler
 - 🔧 A Go compiler (Go 1.18 and above)
-- 🪟 Xorg/Wayland development packages (For Linux only)
-- 🖱️ Supported platform
+- 🪟 On Linux, Xorg/Wayland development packages
 
 For an installation guide, [go here](https://vuelto.pp.ua/install/).
 

diff --git a/website/install.md b/website/install.md
@@ -1,18 +1,18 @@
 # 🔧 Installation
 
+This guide assumes you have the latest version of Golang installed on your system, if not, [refer to this page and follow the instructions for your platform](https://go.dev/dl/).
+
 ## 📦 Go package
 
-We have a Go package published, so run this command to add it to your go.mod:
+We have a Go package published, so run this command to add Vuelto to your `go.mod`:
 
 ```bash
 go get vuelto.pp.ua@latest
 ```
 
 ## 🐧 Linux
 
-You have to have X11-dev-packages and C compiler installed.
-
-### 🖥️ X11
+You need to have X11-dev-packages and C compiler installed.
 
 On Debian and derivate distributions like Ubuntu and Linux Mint the xorg-dev meta-package pulls in the development packages for all of X11.
 
@@ -28,31 +28,21 @@ sudo dnf install libXcursor-devel libXi-devel libXinerama-devel libXrandr-devel
 
 ## 🍎 Mac
 
-You have to have Xcode command line tools installed.
-
-### 📝 Xcode
+You need to have Xcode's command line tools installed.
 
 ```bash
 xcode-select --install
 ```
 
 ## 🪟 Windows
 
-You have to have a C compiler installed. You can also use WSL, if so follow the Linux instructions.
-
-Download Go from the download page and follow instructions.
-
-Install one of the available C compilers for windows, the following are tested with Go and Fyne:
-
-- MSYS2 with MingW-w64 - msys2.org
-- TDM-GCC - tdm-gcc.tdragon.net
-- Cygwin - cygwin.com
+You need to have a C compiler installed. You can also use WSL, if so follow [the Linux instructions](#-linux). We recommend MSYS2 (with MingW-w64), which you can get from [msys2.org](https://www.msys2.org/#installation), and we'll use this compiler for this manual. [TDM-GCC](https://jmeubank.github.io/tdm-gcc/download/) and [Cygwin](https://cygwin.com/) are also tested against Golang and Fyne, and should work properly with Vuelto.
 
-In Windows your graphics driver will already be installed, but it is recommended to ensure they are up to date.
+In Windows, your graphics driver should be already installed, however we still recommend to ensure it's up to date.
 
-The steps for installing with MSYS2 (recommended) are as follows:
+The steps for installing with MSYS2 are as follows:
 
-1. Install MSYS2 from msys2.org
+1. Install MSYS2 from [msys2.org](https://www.msys2.org/#installation)
 2. Once installed do not use the MSYS terminal that opens
 3. Open "MSYS2 MinGW 64-bit" from the start menu
 
@@ -63,10 +53,10 @@ pacman -Syu
 pacman -S git mingw-w64-x86_64-toolchain
 ```
 
-You will need to add /c/Program\ Files/Go/bin and ~/Go/bin to your $PATH, for MSYS2 you can paste the following command into your terminal:
+You will need to add `/c/Program\ Files/Go/bin` and `~/Go/bin` to your `$PATH`, for MSYS2 you can paste the following command into your terminal:
 
 ```bash
 echo "export PATH=\$PATH:/c/Program\ Files/Go/bin:~/Go/bin" >> ~/.bashrc
 ```
 
-For the compiler to work on other terminals you will need to set up the windows %PATH% variable to find these tools. Go to the "Edit the system environment variables" control panel, tap "Advanced" and add "C:\msys64\mingw64\bin" to the Path list.
+For the compiler to work on other terminals you will need to set up the Windows `%PATH%`. Search up "Edit the system environment variables" in Windows search, click "Environment Variables...", then edit `Path` for either your user or the entire system (select it then click "Edit...") and add "`C:\msys64\mingw64\bin`" (or wherever you installed MSYS32 / MINGW64) to the list (click "New" then paste that).
diff --git a/website/roadmap/index.md b/website/roadmap/index.md
@@ -41,7 +41,7 @@
         - [x] GetSize
     - [x] Multiple Windows
         - [x] Remove context management
-        - [x] Automate context managment
+        - [x] Automate context management
 
 - [x] Web image loading
     - [x] HTTP