update readme

This commit is contained in:
Malin Freeborn 2020-01-02 01:30:38 +01:00
parent 6befc5d3c1
commit dac13c2413

View File

@ -1,9 +1,28 @@
This repository started as personal notes, and it's growing into short guides.
This is a list of quickstart guides for Linux programs.
# Purpose
1. Minimal theory, maximum practical.
2. The statements should go in order of how likely they are to be used: if `git add` has to be used by everyone, then it should go first.
3. The scripts should get someone up and running in the shortest possible time.
4. No explanations for the program. This isn't an introduction, it's a guide for someone who already wants to use it.
4. No explanations for the program. This isn't an introduction or advert, it's a guide for someone who already wants to use a program but doesn't know how.
5. Easy reference.
# What's wrong with everything else?
## Man pages
- Orders items by the alphabet rather than by relevance.
- Often presumes you know everything except that one program.
- Often written in the 80's, and it shows.
- Zero respect for your time.
## tl;dr
- Doesn't have the programs I like.
- Too short to get you started on many programs.
- Poor understanding of priority (`git stash` is covered byfore `git commit`).
# History
It started as a few personal notes, and will probably continue to look like that for some time.