Skip to content

Complete README.md rehaul + fix man page

HostGrady requested to merge (removed):master into master

This merge gives a serious update to the README.md. I feel like the look and feel was really bad so I gave it a few new modifications and sections.

New features include:

  • All code blocks have syntax highlights and uses ``` as opposed to tabs or indentation
  • All commands meant to be run at the commandline now have $ to indicate that it is meant to be run as a regular user
  • Better documentation on the makefile (I hope I got the make commands right, I just based it off the PKGBUILD)
  • Adding a new standard of putting your scripts alphabetical order
  • A suggestion to allow contributors to have an easier time

and more...

Besides that, the TODO.md is updated and the man page is corrected.

Merge request reports