Skip to content

README: hide what isn't set up, fix what was wrong - #17

Merged
bsamadi merged 1 commit into
mainfrom
readme-cleanup
Oct 1, 2026
Merged

bsamadi merged 1 commit into
mainfrom
readme-cleanup

Conversation

@bsamadi

@bsamadi bsamadi commented Oct 1, 2026

Copy link
Copy Markdown
Member

README only.

Commented out (hidden on GitHub, kept in the source with a note on how to restore):

  • Read the Docs, PyPI and Codecov badges: no RTD project exists, nothing is on PyPI, Codecov uploads fail without a CODECOV_TOKEN
  • the PyPI install section and the docs link
  • the sphinx-click feature (cannot read Typer 0.27, which vendors Click)
  • the Apple Silicon note (osx-arm64 is already a platform)
  • the --feature dev tip (no environment uses that feature)
  • the LICENSE link: there is no LICENSE file

Fixed: cd academic-project-template and the tree root; "Bandit and pip-audit"; the nox black/isort sessions removed in #11.

🤖 Generated with Claude Code

https://claude.ai/code/session_01AmzgbBq9swiYXP9W9tgbS2

Commented out, with a note on what would restore each: the Read the Docs,
PyPI and Codecov badges (no RTD project, nothing on PyPI, uploads fail
without CODECOV_TOKEN), the PyPI install section, the docs link, the
sphinx-click feature (it can't read Typer 0.27), the Apple Silicon note
(osx-arm64 is already a platform) and the dev-feature tip (no environment
uses that feature).

Fixed: cd academic-project-template, the folder name in the tree, Bandit and
pip-audit, the nox format sessions removed in #11. The LICENSE link is
commented out: the file doesn't exist yet.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01AmzgbBq9swiYXP9W9tgbS2
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Oct 1, 2026
@bsamadi
bsamadi merged commit 5228846 into main Oct 1, 2026
4 checks passed
@bsamadi
bsamadi deleted the readme-cleanup branch October 1, 2026 17:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant