https://github.com/sdhutchins/workshop-cheatsheet

A template Latex file for creating a workshop cheatsheet covering Bash and Git.
https://github.com/sdhutchins/workshop-cheatsheet

bash carpentries cheatsheet git latex template workshop

Last synced: about 1 month ago
JSON representation

A template Latex file for creating a workshop cheatsheet covering Bash and Git.

• Host: GitHub
• URL: https://github.com/sdhutchins/workshop-cheatsheet
• Owner: sdhutchins
• License: lppl-1.3c
• Created: 2023-11-24T05:20:22.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-11-26T04:16:32.000Z (about 1 year ago)
• Last Synced: 2024-11-05T05:43:53.453Z (3 months ago)
• Topics: bash, carpentries, cheatsheet, git, latex, template, workshop
• Language: TeX
• Homepage:
• Size: 256 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Workshop Cheatsheet

This repository provides a LaTeX template for creating cheatsheets.

It has been modified from the work at: .

Modifications include:

- Update of the color to fit usage for UAB.

- Changed content to be basics of Git and Bash.

## Requirements

### macOS Installation (Tested on macOS)

To use this template, you'll need to have the following dependencies installed on your macOS system:

1. MacTeX: This is a distribution of TeX for macOS. You can install it using Homebrew:

   `brew install --cask mactex-no-gui`

2. Make: Ensure that you have the make utility installed on your system. You can install it via Homebrew:

   `brew install make`

## Usage

Follow these steps to create your cheatsheet:

1. Clone or download this repository to your local machine:

   `git clone https://github.com/sdhutchins/workshop-cheatsheet.git`

2. Navigate to the repository directory:

   `cd workshop-cheatsheet`

3. Edit the LaTeX file `src/cheatsheet.tex` with your content.

4. Open a terminal in the repository directory and run the following command to compile the cheatsheet:  

    `make`

5. This will generate a PDF file named cheatsheet.pdf in the src/ directory. You can view the PDF by opening it with your preferred PDF viewer.

6. Customize and enhance the cheatsheet according to your workshop needs.

## Author

Feel free to reach out if you have any questions or need assistance with LaTeX or this template.

Shaurita D. Hutchins | [@sdhutchins](https://github.com/sdhutchins) | [[email protected]](mailto:[email protected])

## License

The LaTeX Project Public License. See the [LICENSE](LICENSE.md) file for more details.