docs: fill empty README.md with module documentation#19
Merged
darknoon29 merged 2 commits intomasterfrom Apr 17, 2026
Merged
Conversation
Agent-Logs-Url: https://github.com/OGSteam/mod-cdr/sessions/88409d70-0708-4300-9bc4-84a4e67c1243 Co-authored-by: darknoon29 <13015521+darknoon29@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix empty README.md file
docs: fill empty README.md with module documentation
Mar 26, 2026
darknoon29
approved these changes
Mar 26, 2026
|
There was a problem hiding this comment.
Pull request overview
This PR replaces an effectively empty README.md with end-user module documentation for the OGSpy “Champs de Ruines (CDR)” module (Xtense-based debris field tracking/display), making the repository self-describing.
Changes:
- Added module description, prerequisites, feature list, and installation/configuration guidance.
- Added contact information, license mention, and a brief version history.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -1 +1,60 @@ | |||
| # mod-cdr | |||
| ## Module OGSpy Champs de Ruines (CDR) | |||
|
|
||
| Ce module permet de trier et visualiser par taille les champs de ruines (CDR) repérés sur le jeu via l'extension Xtense. | ||
|
|
||
| ### Pré Requis ### |
| ### Pré Requis ### | ||
|
|
||
| * Nécessite OGSpy >= 3.3.6 — [Dépôt OGSpy](https://github.com/ogsteam/ogspy) | ||
| * Modules OGspy requis : Xtense |
|
|
||
| ### Licence ### | ||
|
|
||
| GPL-2.0-only — voir [GNU General Public License](http://opensource.org/licenses/gpl-license.php) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
README.mdcontained only the repository name (# mod-cdr) with no useful content.Changes
Style follows the convention of other OGSteam module READMEs (
mod-flottes,mod-attaques).⚡ Quickly spin up Copilot coding agent tasks from anywhere on your macOS or Windows machine with Raycast.