Skip to content

Latest commit

 

History

History
75 lines (48 loc) · 2.23 KB

README.md

File metadata and controls

75 lines (48 loc) · 2.23 KB
Raw

PragProg

This is a little bash script that prints out bits of Hugo Matilla's summary of the The Pragmatic Programmer by Andrew Hunt and David Thomas.

Motivation

Given everyday programming and the subsequent tunnel vision that one sometimes gets during their work, the goal of this project is to have a means to 'ask' for help, inspiration or guidance which can be found in The Pragmatic Programmer book.

Installation

First clone the repo including its submodules:

git clone --recurse-submodules https://github.com/ronanduddy/pragprog.git

To access the CLI tool from anywhere on your machine, one simple approach is to add the following to your ~/.bashrc:

alias pp=~/location/to/pragprog/pp

Where ~/location/to/pragprog/pp is the location of the bash script.

Usage

Next, test that you can run the following command:

pp help

The above command will print the following:

Usage:
	help 	Help
	read 	Read The-Pragmatic-Programmer/readme.md
	toc 	Print the table of contents, used to find chapters and sections.
	x 	Print a chapter. E.g. chapter 1 'A Pragmatic Philosophy'; 1
	x.y 	Print a section of a chapter. E.g. chapter 1, section 2 'Software Entropy'; 1.2
	tips 	Print tips
	ls    	Print checklist

It is possible to print section 2 'Software Entropy' from chapter 1 'A Pragmatic Philosophy', for example, by using the following command:

pp 1.2

Which would print something like:

## 2.-Software Entropy
One broken window ...

**Tip 4: Don't Live with Broken Windows**

Don't mess up the carpet when fixing the broken window.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/ronanduddy/pragprog. Please read CODE_OF_CONDUCT.md for details on our code of conduct.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments