Skip to content

README.md

Latest commit

 

History

History
38 lines (24 loc) · 1.42 KB

README.md

File metadata and controls

38 lines (24 loc) · 1.42 KB

Cursor Configs

License: MIT

A repository of Cursor IDE rules (.mdc files) for software development, including the BMAD (Build, Manage, Architect, Deploy) methodology framework with agents, workflows, and tasks, plus Python and general software engineering good practices.

How to Use

Warning: If your project already contains a .cursor folder, back it up before using this repo (for example, rename it to .cursor.backup) so you can restore any existing settings or rules if needed.

Option 1: Copy Individual Rules

  1. Browse the rules/ directory
  2. Find the rule file that matches your needs
  3. Copy the content to your project's .cursorrules file
  4. Or copy to .cursor/rules/[name].mdc in your project
  5. Restart Cursor or reload the workspace

Option 2: Use as Git Submodule

# In your project directory
git submodule add https://github.com/DeerHide/cursor-rules.git .cursor

# use the following to check whether the submodule is correctly initialized
git submodule status

Contributing

Contributions are welcome! If you have cursor rules that would benefit others, take a look here: CONTRIBUTING

License

MIT License - see LICENSE file for details.

Note: These rules are community-driven and may need customization for your specific project requirements.