Skip to content

Improve README structure and clarity

Otto Kekäläinen requested to merge otto/debmake-doc:improve-readme into master

From commit message:

  • Add a table of contents for easier navigation
  • Improve formatting and consistency in code blocks so they are easy to copy (without the dollar sign) and they render correctly as shell code
  • Fix spelling and grammar issues

These changes make the README more user-friendly and easier to understand, especially for newcomers to the project.

Also apply minor spelling fixes to bin/replace and debian/watch.

There are still some sections I don't understand despite being an experienced Debian Developer, such as why the README suggests to use git deborig in some situations instead of just using the latest git HEAD for development and builds. Also the purpose of the section "Build system" is unclear to me.

Please give feedback and I will update the Merge Request accordingly, with the goal of being fully complete so that you can just merge it when done.

Merge request reports