Differences

This shows you the differences between two versions of the page.

--- getting_started [2025/08/14 20:54] – asie
+++ getting_started [2025/08/15 06:19] (current) – asie
@@ Line 1: / Line 1: @@
-====== Getting Started ======
+====== Installation ======
 The Wonderful toolchain can currently be installed on:
@@ Line 30: / Line 30: @@
   - Run ''%%/opt/wonderful/bin/wf-pacman -Syu wf-tools%%'' (no sudo - you don’t need root!) to synchronize and update the toolchain’s package manager.
   - Run ''%%source /opt/wonderful/bin/wf-env%%'' to configure the toolchain's environment variables.
-    - It is a good idea to add this to the end of ''%%~/.profile%%'' - this way, they will be automatically applied every time you restart the shell.
+    - See ''Configuration -> Environment variables'' for more information.
 ==== Troubleshooting ====
@@ Line 68: / Line 68: @@
   - Run ''%%/opt/wonderful/bin/wf-pacman -Syu wf-tools%%'' (no sudo - you don’t need root!) to synchronize and update the toolchain’s package manager.
   - Run ''%%source /opt/wonderful/bin/wf-env%%'' to configure the toolchain's environment variables.
-    - It is a good idea to add this to the end of ''%%~/.profile%%'' - this way, they will be automatically applied every time you restart the shell.
+    - See ''Configuration -> Environment variables'' for more information.
-==== Alternative: Windows (via WSL2) ====
+==== Alternative options ====
+These are not recommended and are less tested, but have been used successfully by some users.
+=== Windows (via WSL2) ===
 Since WSL2 is compatible with Linux, one can follow the Linux installation instructions to get Wonderful running on top of Windows this way.
@@ Line 79: / Line 83: @@
 Native macOS support is currently not available. For the time being, it is recommended to use a Linux virtual machine.
+====== Configuration ======
+===== Environment variables =====
+To make accessing Wonderful easy, you may want to pre-populate the environment variables in your shell on launch:
+  * For **bash**, add ''%%source /opt/wonderful/bin/wf-env%%'' to your ''%%~/.profile%%''.
+  * For **fish**, add ''%%. /opt/wonderful/bin/wf-env.fish%%'' to your Fish configuration.
+  * For **zsh**, add ''%%source /opt/wonderful/bin/wf-env%%'' to your ''%%~/.zprofile%%''.
+Alternatively, you may want to alias ''%%wf-env%%'' to allow them to be easily added when needed:
+  * For **bash**, add ''%%alias wf-env='source /opt/wonderful/bin/wf-env'%%'' to your ''%%~/.profile%%''.
+  * For **fish**, add ''%%alias wf-env . /opt/wonderful/bin/wf-env.fish%%'' to your Fish configuration.
+  * For **zsh**, add ''%%alias wf-env='source /opt/wonderful/bin/wf-env'%%'' to your ''%%~/.zprofile%%''.
+If you want to access toolchain components (like ''ia16-elf-gcc'' or ''arm-none-eabi-objdump'') directly, you may wish to add the ''%%-a%%'' argument.