Attention

PotatoOS is currently in early alpha and is not available for download. Features and APIs documented here are subject to change.

Introduction

Welcome to the Getting Started guide for PotatoOS!

This section is designed to take you from a curious visitor to a functional user and application developer on the PotatoOS platform. By the end of this guide, you will know how to install PotatoOS, navigate its unique environment, and successfully run your first STARCH application.

System Requirements

Note

Since PotatoOS is built using the Godot Engine, the resource requirements are low, and portability is high.

  • Host Operating System: Any major desktop OS supported by the Godot Engine (Windows, macOS, Linux, or BSD).

  • Storage Space: A minimum of 50 MB of free disk space is required for the PotatoOS application and the internal PotatoFS (virtual file system) structure.

  • Permissions: You must have permission to run executable files on your host operating system and write files to the installation directory, but Administrator/root is not required.

Your PotatoOS Journey

This guide is structured to move you quickly into using the system:

  1. Installation Guide: Detailed steps to download and run the PotatoOS application on your host system.

  2. Basic Usage & Navigation: Learn how to exit the application, launch the Mash Shell, and navigate the essential PotatoFS structure.

  3. Your First Program: A quick tutorial to write a simple “Hello, World!” script in the STARCH language and execute it from the command line.

Ready to begin? Head over to the Installation Guide!