In README.md:

Commit

Maxwell-Rosen3d ago

@@ -13,25 +13,14 @@ Full documentation of the Gkeyll project is available at

Dependencies and Installation

-Postgkyl requires the following packages: +Postgkyl requires the packages listed in pyproject.toml

I suggest you rewrite it with this structure:

Installation

  1. Create environment (at least mention conda, even if you are not going to provide detail steps)

pyenv

mamba

  1. Install dependencies distinguish between dependencies in environment.yml and those in the .toml file (not sure why they can't just stay in a single file, but ok)
  2. Install postgkyl

Documentation

Developing for postgkyl

pytest

formatting

This way the user is first faced with just what it needs to know (installation+documentation). The rest is to be left for later sections

Rewrote README.md with numbered installation steps, pyenv and mamba options, conda guidance, and a plain-language explanation of both dependency files. Documentation comes next, followed by bridge details and development instructions for pytest and formatting.

Checked shell syntax, local links, CLI help, and whitespace.

Entire-Checkpoint: 01M2149062KBJZD88GE0KST23Q

Checkpoints

Restructure README Installation Instructions

CodexGPT-6-astra
View session
Checkpoint 1