Skip to content

Commit 08ee110

Browse files
committed
docs: prominently surface Getting Started guide in README
Add Getting Started as first nav link, centered badge button, callout blockquote, and Quick Start footer link. Condense Quick Start to 3 lines for experienced users with guide link for everyone else. Made-with: Cursor
1 parent a1278ec commit 08ee110

1 file changed

Lines changed: 12 additions & 16 deletions

File tree

README.md

Lines changed: 12 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
</p>
1616

1717
<p align="center">
18+
<a href="docs/GETTING-STARTED.md"><strong>Getting Started</strong></a> &bull;
1819
<a href="#features">Features</a> &bull;
1920
<a href="#quick-start">Quick Start</a> &bull;
2021
<a href="#mcp-server">MCP Server</a> &bull;
@@ -31,6 +32,12 @@
3132

3233
Scaffold complete FiveM/RedM resources, look up native functions, generate manifests, detect frameworks, and write optimized scripts in Lua, JavaScript, and C# -- all from within Cursor's AI chat. Covers the full CFX development lifecycle from project setup to database integration.
3334

35+
<p align="center">
36+
<a href="docs/GETTING-STARTED.md"><img src="https://img.shields.io/badge/%F0%9F%93%96_Getting_Started_Guide-blue?style=for-the-badge" alt="Getting Started Guide"></a>
37+
</p>
38+
39+
> **First time here?** The **[Getting Started guide](docs/GETTING-STARTED.md)** walks you through every step -- from installing Git, Python, and Cursor to building and deploying your first FiveM resource. No prior experience required.
40+
3441
## How It Works
3542

3643
```mermaid
@@ -48,28 +55,17 @@ flowchart LR
4855

4956
## Quick Start
5057

51-
1. **Clone the repo**
58+
Already have Git, Python 3.10+, and Cursor installed? Here's the short version:
5259

5360
```bash
5461
git clone https://github.com/TMHSDigital/CFX-Developer-Tools.git
62+
# Open CFX-Developer-Tools folder in Cursor (File > Open Folder)
63+
cd mcp-server && pip install -r requirements.txt
5564
```
5665

57-
2. **Open in Cursor**
58-
59-
```
60-
File > Open Folder > CFX-Developer-Tools
61-
```
62-
63-
3. **Install MCP server dependencies**
64-
65-
```bash
66-
cd mcp-server
67-
pip install -r requirements.txt
68-
```
69-
70-
4. **Start building** -- ask the AI agent to scaffold a resource, look up a native, or generate a manifest.
66+
Then ask the AI agent to scaffold a resource, look up a native, or generate a manifest.
7167

72-
> **New to Cursor or FiveM development?** See the **[complete setup guide](docs/GETTING-STARTED.md)** for detailed step-by-step instructions covering everything from installing Git and Python to building your first resource.
68+
> **Need more detail?** The **[Getting Started guide](docs/GETTING-STARTED.md)** covers installing prerequisites, troubleshooting, and building your first resource step by step.
7369
7470
## Features
7571

0 commit comments

Comments
 (0)