Skip to content

Commit 9368dbc

Browse files
Add table of contents and improve Readme summary
1 parent ee33c77 commit 9368dbc

1 file changed

Lines changed: 33 additions & 11 deletions

File tree

README.md

Lines changed: 33 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,41 @@
11
# Unity Command Line Launcher
22

3-
A terminal command to open Unity projects quickly from the command line.
3+
A command line utility to open Unity projects quickly.
4+
5+
Builds on top of the Unity (Hub) CLI and adds convenience features for easier usage and makes commands fully compatible
6+
with CI/CD pipelines.
47

58
![Terminal showing ucll opening a Unity project](doc/Screenshot_Open_Path.png)
69

10+
# Table of Contents
11+
12+
- [Main Features](#main-features)
13+
- [Supported Platforms](#supported-platforms)
14+
- [Commands](#commands)
15+
- [Installation](#installation)
16+
- [1 NuGet Global Tool](#1-nuget-global-tool)
17+
- [2 From Source](#2-from-source)
18+
- [3 Download Binaries](#3-download-binaries)
19+
- [Setup](#setup)
20+
- [Interactive Selection Prompt](#interactive-selection-prompt)
21+
- [Enhanced Fuzzy Search (Optional)](#enhanced-fuzzy-search-optional)
22+
- [Shell Completion (Optional)](#shell-completion-optional)
23+
- [Unity Hub](#unity-hub)
24+
- [Usage](#usage)
25+
- [Configuration](#configuration)
26+
- [Tips & Examples](#tips--examples)
27+
- [Design Background](#design-background)
28+
- [Contributing](#contributing)
29+
30+
# Main Features
31+
32+
- Opens Unity projects from the terminal (faster than using the Unity Hub GUI)
33+
- Interactive project selection from Unity Hub's recent projects (optional favorites filter)
34+
- Installs missing Editor versions via Unity Hub
35+
- Forwards additional Unity CLI arguments (e.g. `-batchmode -quit`)
36+
- Helps manage editor installation across many projects (install missing, uninstall unused, etc.)
37+
- Auto-detects Unity Hub and Editor installation paths and allows customization
38+
739
# Supported Platforms
840

941
- macOS
@@ -223,16 +255,6 @@ ucll open path/to/project -- -batchmode -quit
223255
ucll install 2022.3.10f1 -- --module webgl
224256
```
225257

226-
# Features
227-
228-
- Opens Unity projects from the terminal (faster than using the Unity Hub GUI)
229-
- Interactive project selection from Unity Hub's recent projects (optional favorites filter)
230-
- Detects Unity Editor version from projects
231-
- Installs missing Unity Editor versions via Unity Hub
232-
- Fetches changeset info from Unity API when missing in ProjectVersion.txt (e.g. legacy projects)
233-
- Forwards additional Unity CLI arguments (e.g. `-batchmode -quit`)
234-
- Auto-detects Unity Hub and Editor installation paths
235-
236258
# Configuration
237259

238260
> If Unity Hub and the editors are installed in their default location, there should be no configuration needed.

0 commit comments

Comments
 (0)