Improve the README.md file
#172
Conversation
yakutovicha
requested review from
ProkopHapala,
ondrejkrejci,
NikoOinonen and
mondracek
and removed request for
ProkopHapala,
ondrejkrejci and
NikoOinonen
| ### Use ppafm Docker container | ||
|
|
||
| ##### Example 3: Pyridine with Density-overlap | ||
| We propose to use [Docker](https://docs.docker.com/get-docker/) to make the code platform-independent. |
There was a problem hiding this comment.
But we also plan to have wheels for all platforms, which should become the more straightforward installation option for every platform. Docker is useful to have as an option, but in order to keep the README minimal, maybe this should also be moved to the wiki page with additional installation options.
There was a problem hiding this comment.
Since you proposed to make follow-up PRs, will you take care of that too?
|
|
||
| Once the simulation is finished, a number of files and folders will be created. | ||
|
|
||
| ### GUI usage |
There was a problem hiding this comment.
I would move this whole section to the wiki as well. The GUI needs more documentation anyway.
Co-authored-by: NikoOinonen <42408893+NikoOinonen@users.noreply.github.com>
Sure. In that case, nothing is left to do for the current PR. After this is merged, you can go ahead with the follow-ups. |
Follow-up to #172. Fixed a couple of typos and relocated some of the additional instructions to two new wiki pages: https://github.com/Probe-Particle/ppafm/wiki/Additional-installation-instructions https://github.com/Probe-Particle/ppafm/wiki/PPAFM-GUI
fixes #86