You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
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.
33
34
35
+
<palign="center">
36
+
<ahref="docs/GETTING-STARTED.md"><imgsrc="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
+
34
41
## How It Works
35
42
36
43
```mermaid
@@ -48,28 +55,17 @@ flowchart LR
48
55
49
56
## Quick Start
50
57
51
-
1.**Clone the repo**
58
+
Already have Git, Python 3.10+, and Cursor installed? Here's the short version:
# Open CFX-Developer-Tools folder in Cursor (File > Open Folder)
63
+
cd mcp-server && pip install -r requirements.txt
55
64
```
56
65
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.
71
67
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.
0 commit comments