Skip to content

Commit 5b47c69

Browse files
committed
update instruction for using rules for ai
1 parent 19e4f60 commit 5b47c69

File tree

1 file changed

+30
-8
lines changed

1 file changed

+30
-8
lines changed

README.md

+30-8
Original file line numberDiff line numberDiff line change
@@ -6,27 +6,49 @@
66
</a>
77
</p>
88

9-
A curated list of awesome .cursorrules files for enhancing your Cursor AI experience.
9+
A curated list of awesome Rules for AI files for enhancing your Cursor AI experience.
1010

11-
[Cursor AI](https://cursor.sh/) is an AI-powered code editor. `.cursorrules` files define custom rules for Cursor AI to follow when generating code, allowing you to tailor its behavior to your specific needs and preferences.
11+
[Cursor AI](https://cursor.sh/) is an AI-powered code editor. Rules for AI define custom rules for Cursor AI to follow when generating code, allowing you to tailor its behavior to your specific needs and preferences.
1212

13-
## Why .cursorrules?
13+
# Why Rules for AI?
1414

15-
`.cursorrules` is a powerful feature in Cursor AI that allows developers to define project-specific instructions for the AI. Here's why you might want to use it:
15+
**[Rules for AI](https://docs.cursor.com/context/rules-for-ai)** is a powerful feature in Cursor AI that allows developers to define global or project-specific instructions for the AI. Here's why you might want to use it:
1616

17-
1. **Customized AI Behavior**: `.cursorrules` files help tailor the AI's responses to your project's specific needs, ensuring more relevant and accurate code suggestions.
17+
1. **Customized AI Behavior**: Rules files help tailor the AI's responses to your project's specific needs, ensuring more relevant and accurate code suggestions.
1818

19-
2. **Consistency**: By defining coding standards and best practices in your `.cursorrules` file, you can ensure that the AI generates code that aligns with your project's style guidelines.
19+
2. **Consistency**: By defining coding standards and best practices in your rules, you can ensure that the AI generates code that aligns with your project's style guidelines.
2020

2121
3. **Context Awareness**: You can provide the AI with important context about your project, such as commonly used methods, architectural decisions, or specific libraries, leading to more informed code generation.
2222

2323
4. **Improved Productivity**: With well-defined rules, the AI can generate code that requires less manual editing, speeding up your development process.
2424

25-
5. **Team Alignment**: For team projects, a shared `.cursorrules` file ensures that all team members receive consistent AI assistance, promoting cohesion in coding practices.
25+
5. **Team Alignment**: For team projects, shared rules ensure that all team members receive consistent AI assistance, promoting cohesion in coding practices.
2626

2727
6. **Project-Specific Knowledge**: You can include information about your project's structure, dependencies, or unique requirements, helping the AI to provide more accurate and relevant suggestions.
2828

29-
By creating a `.cursorrules` file in your project's root directory, you can leverage these benefits and enhance your coding experience with Cursor AI.
29+
## Setting Up Rules in Cursor
30+
31+
### Global Rules
32+
33+
You can set global rules that apply across all projects:
34+
35+
1. Open Cursor Settings
36+
2. Navigate to General > Rules for AI
37+
3. Add your custom instructions
38+
39+
### Project Rules (Recommended)
40+
41+
Cursor now offers a more powerful and flexible rules system.
42+
43+
**To Create a Project Rule:**
44+
45+
1. Open the command palette (Cmd + Shift + P)
46+
2. Select "New Cursor Rule"
47+
3. Configure your rule with patterns and instructions
48+
49+
### Legacy .cursorrules File
50+
51+
While still supported for backward compatibility, the `.cursorrules` file in the project root is deprecated. We recommend migrating to the new Project Rules system for better flexibility and control over your AI interactions.
3052

3153
## Contents
3254

0 commit comments

Comments
 (0)