Restructure README Installation Instructions

Codex·GPT-6-astra·Maxwell-Rosen·3d ago·6min·1 Checkpoint·1 file change·+180/-118·54.3K tokens

In README.md:

@@ -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 The installation instructions are, overall, confusing. It needs to be written so a high-schooler can just follow a set of steps and do it, without needing to know what a number of things you mention are.

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

Additional installation notes

Gkeyll bridge

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.

3d ago·4.0s

I’ll rewrite the README as a step-by-step installation guide, then move bridge details and development instructions into later sections. I’ll check the dependency files so the guide explains what each installation step does.

environment.yml sets up Python and the installer tools; pyproject.toml lists the packages Postgkyl needs, which pip installs automatically. I’ll make that distinction explicit, keep test tools in the developer section, and give each environment option one clear sequence of commands.

The README now follows the requested order: environment setup, dependencies, installation, documentation, then bridge and development notes. I also corrected two misleading details: users no longer install test tools by default, and the bridge notes explain that a failed source build stops installation. I’m checking the commands and links now.

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.

a4da29bIn README.md: > @@ -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 2. 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) 3. 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+180/-118