@@ -53,7 +53,7 @@ cat install.php | php -- --core # Test piped input locally
5353### Project Organization
5454- ** install.php** : Main installer script (current version defined by CURSOR_RULES_VERSION constant)
5555- ** .cursor/rules/** : Contains 56 MDC rule files organized by category
56- - ** .cursor/UPDATE.md** : Version history file tracking all releases and changes (created by installer)
56+ - ** .cursor/UPDATE.md** : Installation receipt file tracking installed version and configuration (created by installer)
5757- ** .tests/** : Bash test scripts for installer validation
5858- ** .github/workflows/** : CI/CD pipeline using GitHub Actions for PHP 8.3
5959- ** AGENTS.md** : Comprehensive guide for using Cursor Rules (created by installer)
@@ -79,29 +79,29 @@ cat install.php | php -- --core # Test piped input locally
79792 . Script detects if running interactively or with parameters
80803 . Creates .cursor/rules directory structure
81814 . Downloads and installs selected rule files from GitHub
82- 5 . Creates/updates .cursor/UPDATE.md file to track version history
82+ 5 . Creates/overwrites .cursor/UPDATE.md file as an installation receipt
83836 . Creates/updates AGENTS.md documentation (unless --yes flag overwrites)
8484
8585## Versioning System
8686
8787### Version Management
8888- ** Version Constant** : Defined in install.php as ` CURSOR_RULES_VERSION `
89- - ** Version History** : Tracked in .cursor/UPDATE.md file
89+ - ** Version History** : Tracked in GitHub releases and repository documentation
9090- ** Release Process** :
9191 1 . Update CURSOR_RULES_VERSION constant in install.php
92- 2 . Add version entry to .cursor/UPDATE.md with date and changes
92+ 2 . Update version history in repository documentation
9393 3 . Create GitHub release matching the version number
9494 4 . Tag the release in git
9595
9696### .cursor/UPDATE.md File Purpose
97- The UPDATE.md file serves as a version history log that:
98- - Tracks all changes made in each version
99- - Documents new features, bug fixes, and improvements
100- - Records the date of each release
101- - Lists affected files and their impact
102- - Notes any breaking changes
103- - Gets created/updated automatically by the installer in user projects
104- - Helps users understand what changed between versions
97+ The UPDATE.md file serves as an installation receipt that:
98+ - Records the version of cursor-rules that was installed
99+ - Documents the installation date and time
100+ - Lists the number of rule files installed
101+ - Shows the installation type (core, web-stack, Python, etc.)
102+ - Records any tag filters that were applied
103+ - Gets created/overwritten by the installer on each run
104+ - Helps users identify which version and configuration they have installed
105105
106106## Known Issues and Solutions
107107
0 commit comments