ENBT-1970 - Update README.md

README.md

@@ -1,53 +1,159 @@
-# 🚀 Liferay Course Launcher
+# Course Setup Instructions
 
-This project provides a simple, automated way to set up and launch a Liferay DXP environment — with **no technical experience required**.
+Liferay's Course Launcher tool automatically prepares your system and sets up a dedicated workspace for course exercises. Use this tool to streamline course environment setup — with **no technical expertise required**.
 
-Currently, it supports the course:
+This tool:
 
-> 📘 **Backend Client Extensions**  
-> GitHub Repo: [liferay-course-backend-client-extensions](https://github.com/liferay/liferay-course-backend-client-extensions)
+* Checks if Java 21 is installed in your system. If not, it installs Zulu JRE 21 from Azul.
+* Downloads and configures the course workspace.
+* Initializes the local Liferay DXP bundle.
 
-Future versions may support additional Liferay courses.
+## Table of Contents
 
----
+* [Setting Up the Clarity Workspace](#setting-up-the-clarity-workspace)
+* [Manual Setup (Optional)](#manual-setup-optional)
 
-## ✅ What it does
+## Setting Up the Clarity Workspace
 
-- Automatically downloads and configures the course project
-- Checks if Java is installed and is version 21
-- If not, installs **Zulu JRE 21** from Azul
-- Runs `initBundle` to prepare Liferay
-- Starts the Liferay DXP server
+Here, you'll execute the course launcher tool to prepare your system and set up the Clarity workspace you'll use in course exercises.
 
----
+1. Open your terminal and run this command according to your operating system:
 
-## 🖥 Supported Operating Systems
+   <!-- Replace the [COURSE-NAME] placeholder with the corresponding course key. -->
 
-- ✅ macOS
-- ✅ Linux
-- ✅ Windows
+   **Linux/Unix**:
 
----
+   ```bash
+   /bin/bash -c "$(curl -fsSL https://raw.github.com/liferay/liferay-enablement-script-library/main/content-manager-course-setup.sh)" -- --[COURSE-NAME] linux
+   ```
 
-## 💻 How to Use
+   **Mac**:
+   ```bash
+   /bin/bash -c "$(curl -fsSL https://raw.github.com/liferay/liferay-enablement-script-library/main/content-manager-course-setup.sh)" -- --[COURSE-NAME] mac
+   ```
 
-### 🪟 On Windows
+   **Windows**:
+   ```bash
+   powershell Set-ExecutionPolicy Bypass -Scope Process -Force; iex "& { $(irm https://raw.githubusercontent.com/liferay/liferay-enablement-script-library/refs/heads/main/content-manager-course-setup.ps1); install-course --[COURSE-NAME] }"
+   ```
 
-1. Download this folder and unzip it.
-2. Double-click `install-liferay.bat`.
-3. Follow the on-screen instructions.
+   This executes the course launcher tool, which automatically checks for and installs Java JDK 21, downloads the course's files, and prepares the Liferay DXP bundle.
 
-ℹ️ The script will:
-- Open PowerShell behind the scenes
-- Handle setup and installation automatically
+> [!NOTE]
+> The full process may take a few minutes to complete.
 
----
+<!-- Replace the [COURSE-FOLDER-NAME] placeholder with the corresponding course folder. -->
 
-### 🍎 On macOS or 🐧 Linux
+2. Once the "Liferay bundle initialized" message displays, verify the `[COURSE-FOLDER-NAME]/` folder was created.
 
-1. Open your terminal.
-2. Run the following commands (You may need certain priviledges to run these commands).:
+1. Go to the workspace's root folder in your terminal:
 
-```bash
-chmod +x install-liferay-enablement-content-manager-setup.sh 
-./install-liferay-enablement-content-manager-setup.sh
+   <!-- Replace the [COURSE-FOLDER-NAME] placeholder with the corresponding course folder. -->
+
+   ```bash
+   cd [COURSE-FOLDER-NAME]/
+   ```
+
+1. Run this command to start the Liferay server:
+
+   **Unix-based**:
+
+   ```bash
+   ./bundles/tomcat/bin/startup.sh
+   ```
+
+   **Windows**:
+
+   ```bash
+   .\bundles\tomcat\bin\startup.bat
+   ```
+
+1. Verify the “Tomcat started“ message displays.
+
+   This indicates that the server has initiated its startup process in the background.
+
+1. Access your Liferay DXP instance by going to [localhost:8080](http://localhost:8080) in your browser.
+
+> [!NOTE]
+> Server startup may take a few minutes to complete.
+
+7. Sign in using these credentials:
+
+   * Username: `[email protected]`
+   * Password: `learn`
+
+1. Open the *Global Menu*, go to the *Control Panel* tab, and click *Search*.
+
+1. Go to the *Index Actions* tab and click *Reindex for All Search Indexes*.
+
+1. When prompted, click *Execute* to confirm.
+
+1. Take some time to explore the site and resources included in the training workspace.
+
+> [!NOTE]
+> To shutdown your Liferay server, run this command in your terminal:
+>
+> **Unix-based**:
+>
+> ```bash
+> ./bundles/tomcat/bin/shutdown.sh
+> ```
+>
+> **Windows**:
+>
+> ```bash
+> .\bundles\tomcat\bin\shutdown.bat
+> ```
+
+Great! With your environment set up, you’re ready to start contributing to Clarity’s applications.
+
+## Manual Setup (Optional)
+
+Alternatively, you can set up your course environment manually.
+
+> [!NOTE]
+> This process involves more technical steps. If you're using a company system, you may need to contact your company's IT support.
+
+1. Ensure your system satisfies the following prerequisites:
+
+   * Git ([macOS](https://git-scm.com/download/mac) | [Windows](https://git-scm.com/download/win) | [Linux/Unix](https://git-scm.com/download/linux))
+   * Java JDK 21 ([macOS](https://learn.microsoft.com/en-us/java/openjdk/install#install-on-macos) | [Windows](https://learn.microsoft.com/en-us/java/openjdk/install#install-on-windows) | [Linux](https://learn.microsoft.com/en-us/java/openjdk/install#install-on-ubuntu))
+
+1. Open your terminal and clone the training workspace to your computer:
+
+   <!-- Replace the [COURSE-REPO] placeholder with the corresponding course repository link. -->
+
+   ```bash
+   git clone https://github.com/liferay/[COURSE-REPO]
+   ```
+
+   This saves a copy of the project in your current terminal directory.
+
+> [!NOTE]
+> If you've cloned the repo previously, ensure your workspace is up to date by running `git pull origin main`.
+
+3. Go to the workspace's root folder in your terminal:
+
+   <!-- Replace the [COURSE-FOLDER-NAME] placeholder with the corresponding course folder. -->
+
+   ```bash
+   cd [COURSE-FOLDER-NAME]
+   ```
+
+1. Initialize your Liferay bundle.
+
+   **Unix-based**:
+
+   ```bash
+   ./gradlew initBundle
+   ```
+
+   **Windows**:
+
+   ```bash
+   .\gradlew.bat initBundle
+   ```
+
+   This downloads and builds dependencies for running Liferay, including the Liferay Tomcat server.
+
+1. Follow steps 3-9 of the [previous section](#setting-up-the-clarity-workspace).