Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor README #123

Merged
merged 23 commits into from
May 25, 2023
Merged

Refactor README #123

merged 23 commits into from
May 25, 2023

Conversation

LimitlessGreen
Copy link
Contributor

@LimitlessGreen LimitlessGreen commented May 17, 2023

The Readme has grown a lot, and now it's time to go from Markdown to Asciidoc for the following reasons:

  • Automatic Table of Contents
  • Automatic numbering
  • Warning and Info Boxes
  • Customization parameters
  • Advanced table design

I did the following changes:

  • converted the Markdown in Asciidoc with kramdoc
  • Added automatic ToC
  • Added automatic chapter numbers
  • Reformatted the About section
  • Added INFO, TIP and WARNING boxes
  • Added syntax highlighting for some Sh, Json and Python parts
  • Centered the first badges (and found a little HTML "hack")
  • Added social badges

Known bugs:

  • Double dash in E-Mail

Additional information:

  • It seems badgen.net is no longer under active development. Maybe change completely to shields.io
  • Asciidoc also supports bibliography

@LimitlessGreen LimitlessGreen marked this pull request as draft May 20, 2023 08:50
@LimitlessGreen LimitlessGreen marked this pull request as ready for review May 20, 2023 14:50
@Josef-Haupt
Copy link
Collaborator

Josef-Haupt commented May 22, 2023

Hi thanks for your work! I've never used AsciiDoc but willing to learn new technologies.
I'm definitly not against it, but there are some stylistic choices in your port that I would like to change before accepting the PR.
So I'm going to look into AsciiDoc in the coming days and update your branch with some changes.

@Josef-Haupt
Copy link
Collaborator

  • moved the contact buttons to the top
  • simplified some links with a shared variable
  • Set autowidth for the community projects table
  • Added alt text for each image in the community projects table and a forced width of 300 pixels
  • Removed outdated section about a run.bat (no idea where to find it)
  • used explicit code block syntax
  • Changed required Pyhton version to 3.9 and up

@kahst Please have a look, feedback would be appreciated

@Josef-Haupt Josef-Haupt requested a review from kahst May 25, 2023 14:41
@kahst
Copy link
Owner

kahst commented May 25, 2023

Looks good, I like the updated style.

@kahst kahst merged commit 981349e into kahst:main May 25, 2023
@LimitlessGreen
Copy link
Contributor Author

Nice, I like the updated style too and the place for the social badges on top is much better. I not completely like the about section, though (but I'm fine with it). And maybe delete the old README.md file to stop confusion 😅

Josef-Haupt pushed a commit to Josef-Haupt/BirdNET-Analyzer that referenced this pull request Feb 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants