Skip to content

Commit

Permalink
Add documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
tritao committed Sep 21, 2024
1 parent 2662089 commit c86265b
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 0 deletions.
17 changes: 17 additions & 0 deletions website/docs/os.getSystemTags.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
Returns the list of tags corresponding to a system.

There are tags specific to each operating system, and meta tags like `posix`, `darwin`, `desktop` and `mobile` tags.

### Examples ###
```lua
print("iOS system tags: " .. os.getSystemTags("ios"))
-- { "ios", "darwin", "posix", "mobile" },
```

### See Also ###
[os.istarget](os.istarget.md)

### Availability ###

Premake 5.0.0 beta 3 or later.

17 changes: 17 additions & 0 deletions website/docs/os.istarget.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
Checks the target operating system against a particular identifier or tag.
See [os.getSystemTags](os.getSystemTags.md) for documentation about OS tags.

### Examples ###
```lua
print("Android: " .. os.istarget("android"))
print("Mobile: " .. os.istarget("mobile"))
print("Desktop: " .. os.istarget("posix"))
```

### See Also ###
[os.getSystemTags](os.getSystemTags.md)

### Availability ###

Premake 5.0.0 beta 3 or later.

2 changes: 2 additions & 0 deletions website/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -385,13 +385,15 @@ module.exports = {
'os.getcwd',
'os.getnumcpus',
'os.getpass',
'os.getSystemTags',
'os.getversion',
'os.host',
'os.is',
'os.is64bit',
'os.isdir',
'os.isfile',
'os.islink',
'os.istarget',
'os.locate',
'os.matchdirs',
'os.matchfiles',
Expand Down

0 comments on commit c86265b

Please sign in to comment.