almnck/README.md
2025-06-01 20:10:58 -07:00

16 lines
857 B
Markdown

# Directory structure
bin -- small scripts for managing the stuff below
src -- codebase for generating website or conducting process. Anything bigger than a (small) script.
assets -- IP, including incoming articles, images, currently edited work, final products.
web -- the contents of our (static, public) website.
secrets -- passwords, PII, etc. Assume everything else could be made public. If it would be existentially bad for it to leak, encrypt it, and put it here.
doc -- documentation of processes, ideas, memos, etc.
llc -- corporate documents, financial ledger, business running.
venv -- python environment for this whole kiboodle.
To set up an environment that works with these scripts, start a shell
(preferably zsh, though bash should work) in this directory, and type:
```sh
. bin/activate-all
```