Almanack/almnck
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

oops markdown

Browse source
This commit is contained in:
Danny O'Brien 2025-06-01 20:07:21 -07:00
parent 3bc01b211e
commit 50e1903a72
2 changed files with 9 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -1,12 +1,12 @@
# 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
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:

1
secrets Symbolic link
View file

@ -0,0 +1 @@
../almnck-secrets