diff --git a/docs/.vuepress/guide.json b/docs/.vuepress/guide.json index 1195475b4f..b432b7a015 100644 --- a/docs/.vuepress/guide.json +++ b/docs/.vuepress/guide.json @@ -188,17 +188,7 @@ ], { "title": "Prerequisites", - "path": "/guide/Titanium_SDK/Titanium_SDK_Getting_Started/Prerequisites/", - "children": [ - [ - "Titanium_SDK_Getting_Started/Prerequisites/Installing_Oracle_JDK", - "Installing Oracle JDK" - ], - [ - "Titanium_SDK_Getting_Started/Prerequisites/Installing_Node", - "Installing Node" - ] - ] + "path": "/guide/Titanium_SDK/Titanium_SDK_Getting_Started/Prerequisites/" }, [ "Titanium_SDK_Getting_Started/Titanium_SDK_Overview", diff --git a/docs/guide/Titanium_SDK/Titanium_SDK_Getting_Started/Installation_and_Configuration/Installing_Platform_SDKs/Installing_the_Android_SDK.md b/docs/guide/Titanium_SDK/Titanium_SDK_Getting_Started/Installation_and_Configuration/Installing_Platform_SDKs/Installing_the_Android_SDK.md index 8f5dbe77d4..af12938ced 100644 --- a/docs/guide/Titanium_SDK/Titanium_SDK_Getting_Started/Installation_and_Configuration/Installing_Platform_SDKs/Installing_the_Android_SDK.md +++ b/docs/guide/Titanium_SDK/Titanium_SDK_Getting_Started/Installation_and_Configuration/Installing_Platform_SDKs/Installing_the_Android_SDK.md @@ -14,7 +14,7 @@ This guide describes where to obtain and how to install the Google Android SDK a Titanium requires the Android SDK Tools to be installed in order to allow you to develop Android applications. ::: warning ⚠️ Warning -Remember that JDK (Oracle or OpenJDK) is a prerequisite for Android development and should be installed first. You need at least JDK 11 installed. See [Installing Oracle JDK](/guide/Titanium_SDK/Titanium_SDK_Getting_Started/Prerequisites/Installing_Oracle_JDK/) for instructions. +Remember that JDK (Oracle or OpenJDK) is a prerequisite for Android development and should be installed first. ::: Use "Android Studio" from the [Android Studio and SDK tools](https://developer.android.com/studio) to install the SDK and tools. diff --git a/docs/guide/Titanium_SDK/Titanium_SDK_Getting_Started/Installation_and_Configuration/Titanium_Compatibility_Matrix/README.md b/docs/guide/Titanium_SDK/Titanium_SDK_Getting_Started/Installation_and_Configuration/Titanium_Compatibility_Matrix/README.md index 859b6e5112..1ff11434b6 100644 --- a/docs/guide/Titanium_SDK/Titanium_SDK_Getting_Started/Installation_and_Configuration/Titanium_Compatibility_Matrix/README.md +++ b/docs/guide/Titanium_SDK/Titanium_SDK_Getting_Started/Installation_and_Configuration/Titanium_Compatibility_Matrix/README.md @@ -57,8 +57,6 @@ The Java Development Kit (JDK) is required to build Titanium apps and modules fo -See [Installing Oracle JDK](/guide/Titanium_SDK/Titanium_SDK_Getting_Started/Prerequisites/Installing_Oracle_JDK.html) for detailed instructions. - ## Node.js [Node.js](https://nodejs.org/en/download/releases/) is required to install and run Titanium SDK. @@ -74,8 +72,6 @@ On Windows you will need to enable `dev mode` in the Windows settings in order t | 12.6.0 - 12.8.0 | 18.x | 22.x | -See [Installing Node](/guide/Titanium_SDK/Titanium_SDK_Getting_Started/Prerequisites/Installing_Node.html) for details. -
Unsupported version of node.js diff --git a/docs/guide/Titanium_SDK/Titanium_SDK_Getting_Started/Prerequisites/Installing_Node.md b/docs/guide/Titanium_SDK/Titanium_SDK_Getting_Started/Prerequisites/Installing_Node.md deleted file mode 100644 index 2d184199f0..0000000000 --- a/docs/guide/Titanium_SDK/Titanium_SDK_Getting_Started/Prerequisites/Installing_Node.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -title: Installing Node -weight: '20' ---- - -# Installing Node - -Node.js is required for several Titanium SDK components, including the Titanium CLI and Alloy. - -## Compatibility and download - -Titanium supports and recommends the latest Node.js LTS release. - -Check [Titanium Compatibility Matrix](/guide/Titanium_SDK/Titanium_SDK_Getting_Started/Installation_and_Configuration/Titanium_Compatibility_Matrix/) which version of Node.js is required for each Titanium SDK version. - - -## Using NPM packages in Titanium - -1. Run `npm init` in the `app/lib` folder in your **Alloy** project. If you are using a classic app, run the init step in your `/Resources` folder. - -2. Follow the steps npm gives you when doing the init step. Note: You don’t have to fill out anything if you don't need to. - -3. Execute `npm i ` in the `/lib` folder to install a package. For example, let’s set up [to.imagecache](https://www.npmjs.com/package/to.imagecache). You'd use this comment to install the package: `npm i to.imagecache` - -4. Add the `lib/node_modules` folder and the `package-lock.json` file to your `.gitignore` folder. - -5. On any other machine you want to set this up, go to your `/lib` folder, run `npm install` and all packages will be installed to your app. - -### Usage of packages - -Usage of a package is like another module or library file. Using the `to.imagecache` example: - -```javascript -var imageCache = require('to.imagecache'); -``` - -### Dependencies - -To install a package dependency, - -1. Ensure you are in the `/lib` folder, or if using a classic project, the `/Resources` folder. - -2. Execute `npm i ` - -3. To use the dependency, for example a module called `ImageView` from the `to.cacheimageview` (sample extension of the `to.imagecache` package): - - ```xml - - ``` - -### Finding packages - -To find all the current packages with the `titanium-module`, you can use this npm site search: [https://www.npmjs.com/search?q=keywords:titanium-module](https://www.npmjs.com/search?q=keywords:titanium-module) - -A lot of Titanium packages are found using the **titanium** or **titanium-module** keywords. Note: when creating a public common.js module and/or library file, please tag it with the `titanium-module` keyword. - -## Troubleshooting - -### Error: EONT, stat C:\\Users\\\\AppData\\Roaming\\npm - -The error message indicates the folder is missing. To resolve this issue, manually create the folder: - -``` -mkdir C:\Users\\AppData\Roaming\npm -``` - -### Issues installing NPM packages - -If you experience an issue installing any of the `npm` packages, try the following: - -* Check permissions. If you originally ran `npm` using `sudo`, you may need to change the ownership of the `npm` cache folder. - - ```bash - sudo chown -R ~/.npmrc - ``` - - On Windows, the npm cache defaults to `npm-cache` in the user's home folder. - -* Clear the `npm` package cache: - - ```bash - npm cache clean - ``` - -* Remove your `.npmrc` file. diff --git a/docs/guide/Titanium_SDK/Titanium_SDK_Getting_Started/Prerequisites/Installing_Oracle_JDK.md b/docs/guide/Titanium_SDK/Titanium_SDK_Getting_Started/Prerequisites/Installing_Oracle_JDK.md deleted file mode 100644 index 5061fee047..0000000000 --- a/docs/guide/Titanium_SDK/Titanium_SDK_Getting_Started/Prerequisites/Installing_Oracle_JDK.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -title: Installing Oracle JDK -weight: '10' ---- - -# Installing Oracle JDK - -## Compatibility and download - -The Java Development Kit (JDK) is required to build Titanium apps and modules for Android. You can use OpenJDK or Oracle JDK. - -| Titanium SDK version | Min JDK version | Max JDK version | -| --- | --- | --- | -| 10.1.0 - latest | 11 | 16 | -| 9.0.2 - 10.0.2 | 8 | 15 | -| 9.0.1 | 8 | 13 | -| 9.0.0 | 8 | 12 | - -## Installation - -### OS X - -Note that the typical file system location of this software can be found in the [mac OS Software Locations](/guide/Titanium_SDK/Titanium_SDK_Getting_Started/Installation_and_Configuration/Software_Locations_and_Environment_Variables/#macos-software-locations) section of these guides. - -Oracle JDK is installed by default on Mac OS X 10.6 (Snow Leopard) and earlier. - -On Mac OS X 10.7 and later, the OS should prompt you to install it. You can also go to [Apple Developers](https://developer.apple.com/downloads/) and search 'java' to download the installer. - -If you are developing Android applications on your OS X system, you need to install the JDK (Java Development Kit). For details, see [https://support.apple.com/kb/DL1572](https://support.apple.com/kb/DL1572). - -### Windows - -Note that the typical file system location of this software can be found in the [Windows Software Locations](/guide/Titanium_SDK/Titanium_SDK_Getting_Started/Installation_and_Configuration/Software_Locations_and_Environment_Variables/#windows-software-locations) section of these guides. - -* Log in under your usual user account, and right-click the Windows Installer and select _Run as administrator_. Enter the Administrator password, if you are prompted for it, and proceed until the first screenshot below. - -* At the **Java SE Development Kit - Custom Setup** > **Install to** step, select the **Development Tools** component and verify that it is in the location suggested in the [Windows Software Locations](/guide/Titanium_SDK/Titanium_SDK_Getting_Started/Installation_and_Configuration/Software_Locations_and_Environment_Variables/#windows-software-locations) section. If not, correct it accordingly. Proceed to the following screenshot below. - -* Select the **Public JRE** component and verify that it is in the location suggested in the [Windows Software Locations](/guide/Titanium_SDK/Titanium_SDK_Getting_Started/Installation_and_Configuration/Software_Locations_and_Environment_Variables/#windows-software-locations) section. If not, correct it accordingly. - - ![jdk8-install-01](./jdk8-install-01.png) - - ![jdk8-install-02](./jdk8-install-02.png) - -* Wait for the JDK installation to complete. The JRE installation will start automatically. - -* At the **Java Setup** > **Destination Folder** step, verify that the **Install to** path is the same location suggested in the [Windows Software Locations](/guide/Titanium_SDK/Titanium_SDK_Getting_Started/Installation_and_Configuration/Software_Locations_and_Environment_Variables/#windows-software-locations) section. If not, correct it accordingly. - - ![jdk8-install-03](./jdk8-install-03.png) - -* Complete the installation. - -Refer to the [Windows Software Locations](/guide/Titanium_SDK/Titanium_SDK_Getting_Started/Installation_and_Configuration/Software_Locations_and_Environment_Variables/#windows-software-locations) section to add the path to the Oracle JDK `bin` directory to your system's PATH and set the JAVA\_HOME variable. - -### Ubuntu - -See the [Software Locations and Environment Variables](/guide/Titanium_SDK/Titanium_SDK_Getting_Started/Installation_and_Configuration/Software_Locations_and_Environment_Variables/) guide if you need help with setting your system `PATH` or other system variables. - -To install the OpenJDK use the following apt-get command: - -```bash -sudo apt-get update -sudo apt-get install openjdk-11-jdk -``` - -If installing the 64-bit JDK, run `sudo apt-get install ia32-libs`. - -If you have more than one Java installation, run `sudo update-alternatives --config java` and select the correct version. - -## Testing the installation - -Run the following commands from the command-line or terminal on any operating system to determine whether JDK has been installed and configured correctly: - -``` -java -version -javac -version -``` - -You should receive results similar to the following, where both commands are recognized and return the correct version. - -``` -Microsoft Windows [Version 10.0.16299.248] -(c) 2017 Microsoft Corporation. All rights reserved. - -C:\Users\appcel>java -version -java version "1.8.0_162" -Java(TM) SE Runtime Environment (build 1.8.0_162-b12) -Java HotSpot(TM) Client VM (build 25.162-b12, mixed mode) - -C:\Users\appcel>javac -version -javac 1.8.0_162 -``` diff --git a/docs/guide/Titanium_SDK/Titanium_SDK_Getting_Started/Prerequisites/jdk8-install-01.png b/docs/guide/Titanium_SDK/Titanium_SDK_Getting_Started/Prerequisites/jdk8-install-01.png deleted file mode 100644 index e108b92a77..0000000000 Binary files a/docs/guide/Titanium_SDK/Titanium_SDK_Getting_Started/Prerequisites/jdk8-install-01.png and /dev/null differ diff --git a/docs/guide/Titanium_SDK/Titanium_SDK_Getting_Started/Prerequisites/jdk8-install-02.png b/docs/guide/Titanium_SDK/Titanium_SDK_Getting_Started/Prerequisites/jdk8-install-02.png deleted file mode 100644 index 33d7def2d9..0000000000 Binary files a/docs/guide/Titanium_SDK/Titanium_SDK_Getting_Started/Prerequisites/jdk8-install-02.png and /dev/null differ diff --git a/docs/guide/Titanium_SDK/Titanium_SDK_Getting_Started/Prerequisites/jdk8-install-03.png b/docs/guide/Titanium_SDK/Titanium_SDK_Getting_Started/Prerequisites/jdk8-install-03.png deleted file mode 100644 index b7effae528..0000000000 Binary files a/docs/guide/Titanium_SDK/Titanium_SDK_Getting_Started/Prerequisites/jdk8-install-03.png and /dev/null differ diff --git a/docs/guide/Titanium_SDK/Titanium_SDK_Guide/Contributing_to_Titanium/Platform_Development/Building_the_Titanium_SDK_From_Source.md b/docs/guide/Titanium_SDK/Titanium_SDK_Guide/Contributing_to_Titanium/Platform_Development/Building_the_Titanium_SDK_From_Source.md index 38459634a1..bc7b9ab9d4 100644 --- a/docs/guide/Titanium_SDK/Titanium_SDK_Guide/Contributing_to_Titanium/Platform_Development/Building_the_Titanium_SDK_From_Source.md +++ b/docs/guide/Titanium_SDK/Titanium_SDK_Guide/Contributing_to_Titanium/Platform_Development/Building_the_Titanium_SDK_From_Source.md @@ -13,14 +13,10 @@ You must have the following software installed to be able to compile the Titaniu The following software is required for building Titanium applications, and you probably already have it installed: -* [JDK](/guide/Titanium_SDK/Titanium_SDK_Getting_Started/Prerequisites/Installing_Oracle_JDK/) - * [iOS SDK](/guide/Titanium_SDK/Titanium_SDK_Getting_Started/Installation_and_Configuration/Installing_Platform_SDKs/Installing_the_iOS_SDK/) * [Android SDK](/guide/Titanium_SDK/Titanium_SDK_Getting_Started/Installation_and_Configuration/Installing_Platform_SDKs/Installing_the_Android_SDK/) -* [Node.js](/guide/Titanium_SDK/Titanium_SDK_Getting_Started/Prerequisites/Installing_Node/) - The following additional software is required for building the Titanium SDK: * [Android NDK](/guide/Titanium_SDK/Titanium_SDK_Getting_Started/Installation_and_Configuration/Installing_Titanium_Advanced_Tools/Installing_the_Android_NDK/) diff --git a/docs/guide/Titanium_SDK/Titanium_SDK_Guide/Titanium_Command-Line_Interface_Reference/README.md b/docs/guide/Titanium_SDK/Titanium_SDK_Guide/Titanium_Command-Line_Interface_Reference/README.md index 608996b753..60ee250da4 100644 --- a/docs/guide/Titanium_SDK/Titanium_SDK_Guide/Titanium_Command-Line_Interface_Reference/README.md +++ b/docs/guide/Titanium_SDK/Titanium_SDK_Guide/Titanium_Command-Line_Interface_Reference/README.md @@ -37,7 +37,6 @@ Getting started with the CLI only requires two steps: The script prompts you to enter basic information, such as your name, default locale, default SDK version, and default workspace folder. -If you encounter an error installing `titanium`, see [Issues installing NPM packages](/guide/Titanium_SDK/Titanium_SDK_Getting_Started/Prerequisites/Installing_Node/#issues-installing-npm-packages). ## Titanium commands