| 1 | # open hoagie 🥖 |
| 2 | |
| 3 | > It |
| 4 | > Fork this repository. Then carry it carefully to a picnic. |
| 5 | |
| 6 | [!WARNING] This repository is NOT a metaphor. You can actually build this |
| 7 | sandwich. It is fully reproducible from these sources, on a table, with |
| 8 | a knife, and it is delicious. |
| 9 | |
| 10 | ## What is this? |
| 11 | |
| 12 | `big-hoagie` is a small, ergonomic, zero-dependency, fully open-source |
| 13 | sandwich. This monorepo contains the complete source for one deli-quality |
| 14 | hoagie. Bread included -- and it |
| 15 | |
| 16 | There is no runtime, no container, and no cloud. The production |
| 17 | environment is a plate. |
| 18 | |
| 19 | ## Features |
| 20 | |
| 21 | - 🍞 hand-baked `src/bread.py` -- the foundation, don |
| 22 | - 🥩 hand-carved `src/roast_beef.c` at a guaranteed 1.5 mm |
| 23 | - 🧀 `src/swiss_cheese.rs` -- safe, slightly holey |
| 24 | - 🥬 `src/crisp_lettuce.js` -- async but crunchy |
| 25 | - 🍅 `src/vine_ripen_tomato.go`, in season or it doesn |
| 26 | - 🌶️ `src/sriracha_mayo.cpp` -- the binding layer (an emulsion) |
| 27 | - 🥒 `src/dill_pickles.rb` -- optional, flag-controlled |
| 28 | |
| 29 | ## Quick start |
| 30 | |
| 31 | `` |
| 32 | $ git clone https://openhoagie.cybercult.biz/big-hoagie.git |
| 33 | $ cd big-hoagie |
| 34 | $ make lunch |
| 35 | # output: one open hoagie (calories undisclosed) |
| 36 | `` |
| 37 | |
| 38 | ## Installation |
| 39 | |
| 40 | **Requirements:** bread, a sharp knife, a table, one human willing to |
| 41 | share their chips. |
| 42 | |
| 43 | `` |
| 44 | # from source, the only supported way: |
| 45 | $ make lunch |
| 46 | `` |
| 47 | |
| 48 | ## Building from source |
| 49 | |
| 50 | See `Makefile`. Supported targets are `lunch`, `double-meat`, |
| 51 | `no-tomato`, and the forgiving `you-do-you`. Breaking changes to the |
| 52 | layer order are tracked in `CHANGELOG.md` and the git history. |
| 53 | |
| 54 | ## Contributing |
| 55 | |
| 56 | See [CONTRIBUTING.md](CONTRIBUTING.md). Bring your own plate, label your |
| 57 | layers, and do **not** commit the onions without a review. The onion |
| 58 | loophole is real and it is watching you. |
| 59 | |
| 60 | ## License |
| 61 | |
| 62 | Distributed under the [Hoagie General Public License v1.0](LICENSE) |
| 63 | (`HGPL-1.0-only`), which is exactly like the GPL except you additionally |
| 64 | agree to share your chips. Then it |
open hoagie