Skip to content

Improve documentation#9

Open
Wiebke wants to merge 1 commit intomainfrom
documentation-improvements
Open

Improve documentation#9
Wiebke wants to merge 1 commit intomainfrom
documentation-improvements

Conversation

@Wiebke
Copy link
Member

@Wiebke Wiebke commented Feb 6, 2026

This PR improves repository documentation and configuration guidance to enhance software accessibility and reproducibility. It clarifies the setup, more explicitly points to the companion workflow-viz repository, and streamlines environment configuration instructions.

Summary of changes:

  • Refined the README.md structure and wording for clearer setup, architecture, and beamtime execution guidance.
  • Added concise beamtime execution notes covering file watching and autonomous ZMQ-based operation.
  • Aligned and expanded .env.example to include write-mode and beamline-control variables, and clarified data path requirements.

@Wiebke Wiebke requested a review from rajasriramoju February 9, 2026 23:35
Copy link
Contributor

@rajasriramoju rajasriramoju left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The changes look good to me! 👍🏼

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants