https://github.com/ronanduddy/pragprog
A little bash script that can be used to ask for 'Pragmatic Programming' help.
https://github.com/ronanduddy/pragprog
bash helpful pragmatic-programming tool
Last synced: about 1 month ago
JSON representation
A little bash script that can be used to ask for 'Pragmatic Programming' help.
- Host: GitHub
- URL: https://github.com/ronanduddy/pragprog
- Owner: ronanduddy
- License: mit
- Created: 2021-02-09T14:06:58.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-02-10T10:28:09.000Z (over 5 years ago)
- Last Synced: 2025-02-16T15:37:12.479Z (over 1 year ago)
- Topics: bash, helpful, pragmatic-programming, tool
- Language: Shell
- Homepage:
- Size: 16.6 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# PragProg
This is a little bash script that prints out bits of Hugo Matilla's [summary](https://github.com/HugoMatilla/The-Pragmatic-Programmer) of the [The Pragmatic Programmer](https://pragprog.com/titles/tpp20/the-pragmatic-programmer-20th-anniversary-edition/) 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:
```Shell
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`:
```Shell
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:
```Shell
pp help
```
The above command will print the following:
```Shell
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:
```Shell
pp 1.2
```
Which would print something like:
```Shell
## 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](CODE_OF_CONDUCT.md) for details on our code of conduct.
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
## Acknowledgments
* [Hugo Matilla](https://github.com/HugoMatilla)
* [Andrew Hunt & David Thomas](https://pragprog.com/titles/tpp20/the-pragmatic-programmer-20th-anniversary-edition/)