FAIRmat-NFDI / pynxtools-xps

A pynxtools reader plugin for X-ray photoelectron spectroscopy (XPS) data
https://fairmat-nfdi.github.io/pynxtools-xps/
Apache License 2.0
2 stars 0 forks source link

Start documentation #43

Closed lukaspie closed 2 months ago

coveralls commented 2 months ago

Pull Request Test Coverage Report for Build 8894751703

Details


Totals Coverage Status
Change from base Build 8876044305: 0.0%
Covered Lines: 2198
Relevant Lines: 3407

💛 - Coveralls
coveralls commented 2 months ago

Pull Request Test Coverage Report for Build 8921471274

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

Details


Totals Coverage Status
Change from base Build 8876044305: 0.06%
Covered Lines: 2204
Relevant Lines: 3413

💛 - Coveralls
lukaspie commented 2 months ago
  • You have currently some documentation still on the repo's README.md and some already in the doc, do you plan to remove most in the README.md cuz single source principle could be the README is just the link to the doc and maybe here its getting started page

I removed some parts from the README now and replaced them by a link to the docs. For the individual examples, I kept the README, so people can see them immediately in the repo as well. Maybe eventually the docs could also just usethe README files to populate the docs (or vice-versa).