freshlybakedca.ke
Your one-stop-cake-shop for everything Freshly Baked has to offer
docs: improve name formatting
We don't capitalize our project names, with the exception of at the
start of sentences, so it's nice to make them italic: it makes them
stand out a little bit from the text around them
Additionally, several projects weren't linked/etc.
I've done that now :)
a.starrysky.fyi
+24
-23
+24
-23
README.md
+24
-23
README.md
···
1
-
# Welcome to the Patisserie
1
+
# Welcome to the *patisserie*
2
2
3
-
*~ your one-stop-cake-shop for everything Freshly Baked has to offer*
3
+
*~ your one-stop-cake-shop for everything Freshly Baked has to offer ~*
4
4
5
5
## Structure
6
6
7
-
Patisserie is a [monorepo](https://en.wikipedia.org/wiki/Monorepo), which means
7
+
*Patisserie* is a [monorepo](https://en.wikipedia.org/wiki/Monorepo), which means
8
8
there are multiple projects hosted here. Here's a list!
9
9
10
-
| Project | Description |
11
-
| --------- | -------------------------------------------------------------------- |
12
-
| packetmix | Our NixOS configurations ("All you need to bake a delicious system") |
10
+
| Project | Description |
11
+
| ----------- | ------------------------------------------------------------------------------------------- |
12
+
| *packetmix* | Our [*NixOS*](https://nixos.org) configurations ("All you need to bake a delicious system") |
13
13
14
14
## Cloning a single project
15
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:
16
+
You may clone and push to *patisserie* via [*tangled*](https://tangled.sh) as
17
+
you usually would. If you'd like to clone only a single project, however, we
18
+
provide a public [*josh* proxy](https://josh-project.github.io/josh/) which can
19
+
be used to filter your clone:
20
20
21
21
```bash
22
22
git clone https://git.freshlybakedca.ke/patisserie.git:/packetmix.git
23
23
# Swap out "packetmix" at the end of the URL for whatever project you want to clone
24
24
```
25
25
26
-
If you need to push then, as with tangled normally, you are required to use SSH.
26
+
If you need to push then, as with *tangled* normally, you are required to use
27
+
SSH.
27
28
28
-
Josh can push via SSH, but requires you to forward your SSH agent to
29
+
*Josh* can push via SSH, but requires you to forward your SSH agent to
29
30
authenticate your push:
30
31
31
32
```ssh-config
···
47
48
48
49
### Creating new branches
49
50
50
-
When pushing to josh, creating branches won't work on a regular git push. This
51
-
is because josh doesn't know what state you want the rest of the repository to
52
-
be for your branch
51
+
When pushing to *josh*, creating branches won't work on a regular `git push`.
52
+
This is because *josh* doesn't know what state you want the rest of the
53
+
repository to be for your branch
53
54
54
-
You can tell josh by providing the `base=` push option like so:
55
+
You can tell *josh* by providing the `base=` push option like so:
55
56
56
57
```bash
57
58
git push origin HEAD:my-new-branch -o base=main
58
59
```
59
60
60
-
If you want to always pick main by default you can set this in your
61
-
repository-specific git config
61
+
If you want to always pick `main` by default you can set this in your
62
+
repository-specific *git* config
62
63
63
64
```bash
64
65
git config push.pushOption 'base=main'
65
66
```
66
67
67
-
Setting this in your git config may also be useful if
68
-
you're using an alternative git frontend, for example
69
-
[Jujutsu](https://jj-vcs.github.io/jj/latest/), which does not provide the
68
+
Setting this in your *git* config may also be useful if
69
+
you're using an alternative *git* frontend, for example
70
+
[*Jujutsu*](https://jj-vcs.github.io/jj/latest/), which does not provide the
70
71
ability to set push-options when pushing to git remotes
71
72
72
73
### Signing commits
73
74
74
-
As josh rewrites commits, they will not be validly signed everywhere.
75
-
We therefore recommend you turn off commit signing for patisserie or any
75
+
As *josh* rewrites commits, they will not be validly signed everywhere.
76
+
We therefore recommend you turn off commit signing for *patisserie* or any
76
77
subprojects which you clone down
77
78
78
79
For example,