Skip to content

Commit

Permalink
more links to platform setup for specific targets
Browse files Browse the repository at this point in the history
And some general cleanup
  • Loading branch information
joshtynjala committed Jul 26, 2024
1 parent dc9a9be commit 927d2a2
Show file tree
Hide file tree
Showing 8 changed files with 54 additions and 38 deletions.
6 changes: 3 additions & 3 deletions _docs/advanced-setup.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Advanced Setup
# redirect because it's a blank page
redirect_to: /docs/home/
title: Platform Setup
# redirect to an appropriate sub-page because this is a blank page
redirect_to: /docs/advanced-setup/html5/
---
4 changes: 2 additions & 2 deletions _docs/command-line-tools.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Command-Line Tools
# redirect because it's a blank page
redirect_to: /docs/home/
# redirect to an appropriate sub-page because this is a blank page
redirect_to: /docs/command-line-tools/basic-commands/
---
20 changes: 11 additions & 9 deletions _docs/command-line-tools/basic-commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,16 @@ If you are in the same directory as your project:

You can substitute "neko" for any Lime target, including:

* windows
* mac
* linux
* ios
* android
* flash
* air
* html5
* [windows](../../advanced-setup/windows/)
* [mac](../../advanced-setup/macos/)
* [linux](../../advanced-setup/linux/)
* [ios](../../advanced-setup/ios/)
* [android](../../advanced-setup/android/)
* [flash](../../advanced-setup/flash/)
* [air](../../advanced-setup/air/)
* [html5](../../advanced-setup/html5/)
* [hl](../../advanced-setup/hashlink/)
* [electron](../../advanced-setup/electron/)

Some targets are not available from every host platform. For example, iOS is only available when using macOS.

Expand Down Expand Up @@ -62,7 +64,7 @@ All of the same flags and targets apply.

The "setup" command can help download and install the dependencies needed to target certain platforms, or to tell the command-line tools where it can find where these tools are installed. For example, the Android SDK and NDK when targeting Android, or installing Visual Studio C++ for Windows.

Follow the pages under the "Advanced Setup" section to setup each platform.
Follow the pages under the [Platform Setup](../../advanced-setup/) section to setup each platform.

## lime help

Expand Down
2 changes: 1 addition & 1 deletion _docs/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Getting Started
# redirect because it's a blank page
# redirect to an appropriate sub-page because this is a blank page
redirect_to: /docs/home/
---
24 changes: 12 additions & 12 deletions _docs/getting-started/targets.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,27 +10,27 @@ lime help build

## Targets

* air -- Create an Adobe AIR application
* android -- Create an Android application
* [air](../../advanced-setup/air/) -- Create an Adobe AIR application
* [android](../../advanced-setup/android/) -- Create an Android application
* emscripten -- Create an Emscripten application
* flash -- Create a Flash SWF application
* html5 -- Create an HTML5 application
* ios -- Create an iOS application
* linux -- Create a Linux application
* mac -- Create a macOS application
* [flash](../../advanced-setup/flash/) -- Create a Flash SWF application
* [html5](../../advanced-setup/html5/) -- Create an HTML5 application
* [ios](../../advanced-setup/ios/) -- Create an iOS application
* [linux](../../advanced-setup/linux/) -- Create a Linux application
* [mac](../../advanced-setup/macos/) -- Create a macOS application
* tvos -- Create a tvOS application
* windows -- Create a Windows application
* [windows](../../advanced-setup/windows/) -- Create a Windows application

## Target Aliases

* cpp -- Alias for host platform (using -cpp)
* neko -- Alias for host platform (using -neko)
* macos -- Alias for mac
* [neko](../../advanced-setup/neko/) -- Alias for host platform (using -neko)
* [macos](../../advanced-setup/macos/) -- Alias for mac
* nodejs -- Alias for host platform (using -nodejs)
* java -- Alias for host platform (using -java)
* cs -- Alias for host platform (using -cs)
* hl/hashlink -- Alias for host platform (using -hl)
* [hl/hashlink](../../advanced-setup/hashlink/) -- Alias for host platform (using -hl)
* uwp/winjs -- Alias for windows -uwp
* rpi/raspberrypi -- Alias for linux -rpi
* electron -- Alias for html5 -electron
* [electron](../../advanced-setup/electron/) -- Alias for html5 -electron
* webassembly/wasm -- Alias for emscripten -webassembly
16 changes: 9 additions & 7 deletions _docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ redirect_from: docs/index.html

## Install Haxe

If you have not already, install [Haxe](https://haxe.org/download/) for your current platform. Lime supports Windows, macOS and Linux host platforms.
If you have not already, install [Haxe](https://haxe.org/download/) for your current platform. Lime projects can be built on Windows, macOS and Linux.


## Install Lime
Expand All @@ -24,12 +24,10 @@ To confirm that Lime is installed and working properly, try running the "lime" c
lime
```


## Install a Code Editor

We recommend [Visual Studio Code](https://code.visualstudio.com), using the [Lime Extension](https://marketplace.visualstudio.com/items?itemName=openfl.lime-vscode-extension), but many [other code editors](../getting-started/choosing-a-code-editor) are also compatible with Haxe development.


## Run a Sample

Lime includes some simple sample projects to help you get started. For example, the "SimpleImage" sample illustrates an example of rendering graphics for multiple platforms and renderers:
Expand All @@ -45,12 +43,16 @@ lime test neko -Dcairo
lime test flash
```

Lime will use a OpenGL-based renderer by default, but attempts to fallback to a software renderer (such as HTML5 canvas or Cairo) when it is unavailable.

Lime will use a hardware-accelerated OpenGL renderer by default, but attempts to fall back to a software renderer (such as the [HTML5 Canvas API](https://developer.mozilla.org/en-US/docs/Web/API/Canvas_API) or [Cairo for native 2D Graphics](https://www.cairographics.org/)) when OpenGL is unavailable on the current system. You can add the `-Dcanvas` flag to the `html5` target or the `-Dcairo` flag to native targets to force software rendering.

## Use Additional Platforms

Lime and OpenFL support many [target platforms and operating systems](../getting-started/targets/), including native C++ apps on Windows, macOS, Linux, Android, and iOS, HTML5 on the web or as an app with Electron, the HashLink virtual machine, Adobe AIR, and more.
Lime and OpenFL support many [target platforms and operating systems](../getting-started/targets/), including:

- Native C++ desktop apps on [Windows](../advanced-setup/windows/), [macOS](../advanced-setup/macos/), [Linux](../advanced-setup/linux/)
- Native C++ mobile apps on [Android](../advanced-setup/android/), and [iOS](../advanced-setup/ios/)
- [HTML5](../advanced-setup/html5/) on the web
- Using cross-platform runtimes like [Electron](../advanced-setup/electron/), the [HashLink](../advanced-setup/hashlink/) virtual machine, and [Adobe AIR](../advanced-setup/air/)

Some target platforms require extra setup before they will work properly with Lime. After you confirm that things are running properly, you can try configuring a new platform:

Expand All @@ -62,4 +64,4 @@ lime setup android
lime setup ios
```

Follow the pages under the "Advanced Setup" section for more detailed information to setup each platform.
Follow the pages under the [Platform Setup](../advanced-setup/) section for more detailed information to setup each platform.
4 changes: 2 additions & 2 deletions _docs/project-files.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Project Files
# redirect because it's a blank page
redirect_to: /docs/home/
# redirect to an appropriate sub-page because this is a blank page
redirect_to: /docs/project-files/xml-format/
---
16 changes: 14 additions & 2 deletions _docs/project-files/xml-format/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The following targets have additional unique options.

### C++

These options are shared by all targets that use C++, including Android, iOS, Windows, Mac, and Linux.
The following options are shared by all targets that use C++, including [Android](../../../advanced-setup/android/), [iOS](../../../advanced-setup/ios/), [Windows](../../../advanced-setup/windows/), [macOS](../../../advanced-setup/macos/), and [Linux](../../../advanced-setup/linux/).

```xml
<config:cpp requireBuild="true" />
Expand All @@ -37,6 +37,8 @@ These options configure how `lime rebuild` compiles a C++ library project.

### Adobe AIR

The following options are available for [Adobe AIR](../../../advanced-setup/air/) only.

```xml
<config:air sdk-version="28.0" />
<config:air profile="extendedDesktop" /> <!-- set a custom AIR device profile -->
Expand All @@ -48,6 +50,8 @@ These options configure how `lime rebuild` compiles a C++ library project.

### Android

The following options are available for [Android](../../../advanced-setup/android/) only.

```xml
<config:android install-location="auto" />
<config:android minimum-sdk-version="21" />
Expand All @@ -71,12 +75,16 @@ These options configure how `lime rebuild` compiles a C++ library project.

### HTML5

The following options are available for [HTML5](../../../advanced-setup/html5/) only.

```xml
<config:html5 dependency-path="lib" />
```

### iOS

The following options are available for [iOS](../../../advanced-setup/ios/) only.

```xml
<config:ios device="universal" /> <!-- Other options: "iphone", "ipad" -->
<config:ios deployment="9.0" />
Expand All @@ -97,6 +105,8 @@ These options configure how `lime rebuild` compiles a C++ library project.

### tvOS

The following options are available for tvOS only.

```xml
<config:tvos device="appletv" />
<config:tvos deployment="9.0" />
Expand All @@ -111,7 +121,9 @@ These options configure how `lime rebuild` compiles a C++ library project.
<config:tvos linker-flags="-stdlib=libc++" />
```

### Webassembly
### WebAssembly

The following options are available for WebAssembly only.

```xml
<config:webassembly dependency-path="lib" />
Expand Down

0 comments on commit 927d2a2

Please sign in to comment.