Skip to content
This repository was archived by the owner on Apr 29, 2024. It is now read-only.

Commit cc95522

Browse files
committed
chore(docs): documentation scaffold
Summary: Just to put more things in place. Signed-off-by: Austin Seipp <aseipp@pobox.com> Change-Id: I2ae9ccfe205959f983f62475bd8f822f
1 parent 068bb0f commit cc95522

File tree

3 files changed

+39
-1
lines changed

3 files changed

+39
-1
lines changed

README.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,28 @@
11
# prototype nix package for supabase postgres
22

3-
Placeholder. Real documentation TBD.
3+
This repository contains **experimental code** to package PostgreSQL using
4+
**[Nix]**, and tooling and infrastructure for deploying it.
5+
6+
Don't know Nix? Want to understand some of the thinking here? To learn about Nix
7+
and some of the design constraints this repository are under, please see the
8+
[`docs/`](./docs/) directory which should help get you up to speed.
9+
10+
If you want to install Nix and play along quickly, check out the
11+
[Start Here](./docs/00-START-HERE.md) page.
12+
13+
[Nix]: https://nixos.org
14+
15+
## Quick start
16+
17+
NIH. Will come a little later. Read docs or ask me questions directly in the
18+
mean time.
19+
20+
## Other notes
21+
22+
- This repository should work "in perpetuity" (assuming Nix doesn't horribly
23+
break years down the line), but will probably be migrated elsewhere if it's
24+
successful, so don't get too cozy or familiar.
25+
- Austin uses **[jujutsu]** to develop this repository; but you don't have to
26+
(you should try it, though!) The workflow used for this repo is "linear
27+
commits, no merges." If you submit PRs, they'll be rebased on top of the
28+
existing history to match that. (YMMV but I prefer this style.)

docs/00-START-HERE.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# 00 — Starting Line: installing Nix and playing around
2+
3+
Lorem in aliquip cupidatat cupidatat est mollit...

docs/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Documentation
2+
3+
This contains all the needed documentation to (hopefully) help you explicate and
4+
understand what Nix is, how to use it wisely, how to play with PostgreSQL, and
5+
probably other stuff to help educate you.
6+
7+
## Table of Contents
8+
9+
- **[00 — Starting Line](./00-START-HERE.md)** — we'll install Nix and play
10+
around with it a little.

0 commit comments

Comments
 (0)