CFEL-CMI / CFEL-CMI/cmifly

Provide basic documentation

Open
#3 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
0
Forks
0
PR merge metrics
No merged PRs in 30d

Description

Provide some basic documentation, preferably using a restructured text file (or files) in a `doc` folder.

Contributor guide

No contributing guide indexed for this repository

Research direction

No files, tests, or entry points are named. First inspect the Python project structure and understand the trajectory-based molecular-beam deflection simulation, then add basic reStructuredText documentation in a doc folder; done means the project has useful introductory documentation covering its purpose and basic use.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.