Add app.os object

Author: dacap

Changes.md

@@ -24,6 +24,11 @@ else
 end
 ```
 
+## v1.3.7
+
+* [`app.apiVersion`](api/app.md#appapiversion) is `28`
+* New [`app.os`](api/app_os.md#appos) with some properties about the running platform
+
 ## v1.3.3
 
 * [`app.apiVersion`](api/app.md#appapiversion) is `27`

LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2018  Igara Studio S.A.
+Copyright (c) 2018-2024  Igara Studio S.A.
 Copyright (c) 2015-2018  David Capello
 
 Permission is hereby granted, free of charge, to any person obtaining a copy

README.md

@@ -41,6 +41,7 @@ Globals namespaces
   * [app](api/app.md#app)
   * [app.command](api/app_command.md#appcommand)
   * [app.fs](api/app_fs.md#appfs)
+  * [app.os](api/app_os.md#appos)
   * [app.pixelColor](api/pixelcolor.md#apppixelcolor)
   * [app.theme](api/app_theme.md#apptheme)
   * [json](api/json.md#json)

api/app_os.md

@@ -0,0 +1,44 @@
+# app.os
+
+A set of function to get properties about the running Operating System
+platform.
+
+## app.os.name
+
+```lua
+local name = app.os.name
+```
+
+Returns the platform name. It can be `Windows`, `macOS`, or `Linux`.
+
+## app.os.version
+
+Returns an [`Version`](version.md#version) with the Windows or macOS
+version. It's just `0.0.0` on Linux.
+
+## app.os.fullName
+
+Returns the full platform name with its version. On Linux returns the
+distribution name with its specific version.
+
+Some examples: `Windows NT 10.0.22631`, `macOS 14.4.1`, `Pop!_OS 22.04 LTS`, etc.
+
+## app.os.windows
+## app.os.macos
+## app.os.linux
+## app.os.x64
+## app.os.x86
+## app.os.arm64
+
+These are `true`/`false` properties if we are running in the given
+platform. For example:
+
+```lua
+if app.os.windows then
+  print("Running on Windows")
+elseif app.os.macos then
+  if app.os.arm64 then
+    print("Running on Apple Silicon")
+  end
+end
+```

sidebar.md

@@ -7,6 +7,7 @@ Globals namespaces
   * [app](api/app.md#app)
   * [app.command](api/app_command.md#appcommand)
   * [app.fs](api/app_fs.md#appfs)
+  * [app.os](api/app_os.md#appos)
   * [app.pixelColor](api/pixelcolor.md#apppixelcolor)
   * [app.theme](api/app_theme.md#apptheme)
   * [json](api/json.md#json)