Skip to content

Commit

Permalink
chore: update readme (#13)
Browse files Browse the repository at this point in the history
  • Loading branch information
gphorvath authored Nov 2, 2024
1 parent 3b33628 commit b902ebf
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 11 deletions.
35 changes: 24 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,50 @@
# Swiss Army Knife

A curated collection of templates and lessons learned from my personal journey as a developer.
![](docs/images/swiss-army-knife.jpeg)

## Overview

This repository serves as a personal toolkit, housing various templates, code snippets, and documented insights gathered throughout my development career. It's designed to be a quick reference and a source of reusable components for future projects.
**Swiss Army Knife** is a set of commonly used templates and automation to jump-start new projects. The goal of this repo is to add some amount of quality control prior to writing code, with as little effort as possible.

## Usage

Feel free to explore the repository and use any code or information that you find helpful.
### Option 1: Most or All

The repository is designed to be used as a submodule from the base of your repo.
This repository is designed to be used as a submodule or cloned directly into the root of your new project.

```bash
git submodule add [email protected]:gphorvath/swiss-army-knife.git
# clone or submodule this repo into the root of your new project

cd swiss-army-knife

make <choose a setup command>
make help # To see all the various components

make install # Installs everything
```

### Option 2: Cherry Pick

To cherry-pick examples from this repo, check out the [/docs](/docs/) section for all the different components. Some components have multiple files (e.g., workflows with config files), so double-check the project tree to ensure you get everything.

## FAQ

### Why not simply use a GitHub Template Repository?

The hope is that this repo ultimately fixes two main problems with template repos:

1. Retrofitting existing repos
2. Propagating changes and updates

It is not impossible to do these things, but the process is generally manual.

## Contributing

While this is primarily a personal collection, I welcome suggestions and improvements. If you have ideas or spot any issues, please open an issue or submit a pull request.
Suggestions and improvements welcome! If you have ideas or spot any issues, please open an issue or submit a pull request.

## License

This project is open source and available under the [MIT License](LICENSE).

## Disclaimer

This repository reflects my personal experiences and preferences. While I strive to maintain best practices, always use your judgment when applying these templates and lessons to your own projects.

## Contact

If you have any questions or would like to discuss anything in this repository, feel free to [open an issue](../../issues) or reach out to me directly.
Expand Down
Binary file added docs/images/swiss-army-knife.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit b902ebf

Please sign in to comment.