Repository navigation
readme - #59
Merged
Merged
readme#59
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR standardizes and expands the repository README to provide clearer context, installation steps, requirements, and basic usage guidance for the Atomic Caldera plugin.
Changes:
- Replaces the prior short README with expanded sections (overview, limitations, install, requirements, getting started).
- Adds step-by-step installation instructions and dependency notes.
- Adds UI/usage guidance and an additional note about
$PathToAtomicsFolderhandling.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
deacon-mp
previously approved these changes
Apr 30, 2026
5 of 6 tasks
Copilot AI
added a commit
that referenced
this pull request
Apr 30, 2026
…g PR #59 up to date with master This merge brings the atomicreadme branch (PR #59) up to date with master. - atomicreadme was 15 commits behind master - atomicreadme had 6 unique README.md commits - No conflicts: master had not changed README.md since the fork point - All master improvements (tests, security fixes, CI, etc.) are now included Closes: references PR #59 Co-authored-by: deacon-mp <61169193+deacon-mp@users.noreply.github.com>
Copilot AI
added a commit
that referenced
this pull request
Apr 30, 2026
- Update tox.ini: remove caldera cloning (tests use mocking), fix allowlist_externals wildcard issue, update Python version targets to match CI workflow (py310-py313), simplify deps - Fix test_hook.py: save PropertyMock reference before setting on type to allow correct assert_called() assertion Relates to PR #59 (atomicreadme) being behind master Agent-Logs-Url: https://github.com/mitre/atomic/sessions/3e6bc91d-1027-4879-bf76-787900697133 Co-authored-by: deacon-mp <61169193+deacon-mp@users.noreply.github.com>
dancy-bear
pushed a commit
to dancy-bear/atomic
that referenced
this pull request
Oct 11, 2026
PR mitre#59 (mitre/atomicreadme) replaced the accurate auto-clone plugin docs with the obsolete AtomicCaldera (xenoscr/atomiccaldera) manual setup steps — clone atomiccaldera, clone mitre/cti, edit conf/artconf.yml, add atomiccaldera to plugins. None of that applies to this plugin: it auto-clones atomic-red-team into data/ on first enable() and reads the enterprise-attack.json bundled inside the ART repo for technique→tactic mapping. There is no conf/artconf.yml, no separate CTI clone, and the plugin name is `atomic` not `atomiccaldera`. Restores README.md from b909588 (the version every other Caldera checkout still pins), keeping the AtomicCaldera credit in Acknowledgements. Plugin code (tox CI fixes etc. from later commits) is unchanged — only the docs revert.
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.
Description
read me standardization and updates
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
Please describe the tests that you ran to verify your changes.
Checklist: