Your one-stop-cake-shop for everything Freshly Baked has to offer

docs: describe patisserie structure and tooling

+46
+46
README.md
··· 1 + # Welcome to the Patisserie 2 + 3 + *~ your one-stop-cake-shop for everything Freshly Baked has to offer* 4 + 5 + ## Structure 6 + 7 + Patisserie is a [monorepo](https://en.wikipedia.org/wiki/Monorepo), which means 8 + there are multiple projects hosted here. Here's a list! 9 + 10 + | Project | Description | 11 + | --------- | -------------------------------------------------------------------- | 12 + | packetmix | Our NixOS configurations ("All you need to bake a delicious system") | 13 + 14 + ## Cloning a single project 15 + 16 + You may clone and push to patisserie via tangled as you usually would. If you'd 17 + like to clone only a single project, however, we provide a public 18 + [josh proxy](https://josh-project.github.io/josh/) which can be used to filter your 19 + clone: 20 + 21 + ```bash 22 + git clone https://git.freshlybakedca.ke/patisserie.git:/packetmix.git 23 + # Swap out "packetmix" at the end of the URL for whatever project you want to clone 24 + ``` 25 + 26 + If you need to push then, as with tangled normally, you are required to use SSH. 27 + 28 + Josh can push via SSH, but requires you to forward your SSH agent to 29 + authenticate your push: 30 + 31 + ```ssh-config 32 + # In ~/.ssh/config 33 + Host git.freshlybakedca.ke 34 + Hostname teal 35 + # ^ Pushing can currently only be done from inside our Tailscale network. We are considering solutions to this limitation 36 + User git 37 + ForwardAgent yes 38 + ``` 39 + 40 + When you've added this section to your ssh config, you can clone over SSH. 41 + Pushing will work as normal for SSH clones. 42 + 43 + ```bash 44 + git clone ssh://git@git.freshlybakedca.ke/patisserie.git:/packetmix.git 45 + # Swap out "packetmix" at the end of the URL for whatever project you want to clone 46 + ```