Convert README.nfo to README.org !1

merged merged by cmc on 2026-08-31 22:38 UTC · krz/brand-bench:nfo-to-org into main

2 files changed, +87 −79

Layout: unified · split

README.nfo deleted −79

		@@ -1,79 +0,0 @@
1		┌──────────────────────────────────────────────────────────────┐
2		│ B R A N D B E N C H [ KRZ ] krz.sh │
3		└──────────────────────────────────────────────────────────────┘
4
5		WHAT
6		client-side brand identity generator. describe a project, get a
7		brand package: positioning, tone, color palette, typography, logo
8		concepts, taglines, usage examples. runs in the browser.
9
10		no backend. no accounts. state persists in localStorage.
11
12		DOES
13		- template generation, offline, tailored by category
14		- ai generation via a local ollama instance, cancellable mid-stream
15		- multiple packages in tabs, each persisted separately
16		- inline editing, click any field in the preview
17		- section locking across regenerations
18		- undo/redo per package (⌘Z / ⌘⇧Z)
19		- editable color swatches, native color picker
20		- font pairings per category, 8-level type scale
21		- export to markdown, json, or a self-contained html page
22
23		RUN
24		npm install
25		npm run dev
26
27		open http://localhost:5173.
28
29		build:
30
31		npm run build # dist/
32		npm run preview
33
34		AI WITH OLLAMA
35		1. install ollama, pull a model:
36
37		ollama pull llama3.2
38		ollama pull mistral
39		ollama pull gemma3
40
41		2. run it:
42
43		ollama serve
44
45		3. a non-default host or port needs OLLAMA_ORIGINS set for browser
46		requests:
47
48		OLLAMA_ORIGINS="*" ollama serve
49
50		4. in the app: Settings, enable AI, set base url
51		(http://localhost:11434), pick a model, Test connection.
52
53		bigger models give better-structured output. generation takes
54		15-60s depending on hardware.
55
56		DOCKER
57		Dockerfile and compose.yml deploy the app next to ollama.
58
59		docker compose up -d --build
60
61		app serves on port 8000. ollama's api is proxied through nginx at
62		/api/, so the browser makes no cross-origin request. after first
63		boot, pull a model:
64
65		docker compose exec ollama ollama pull llama3.2
66
67		set the ollama base url to http://your-server:8000. for an nvidia
68		gpu, uncomment the deploy block in compose.yml (needs the nvidia
69		container toolkit).
70
71		STACK
72		react 18, typescript, vite. no ui library, plain css.
73
74		LICENSE
75		0bsd. see LICENSE.
76
77		┌──────────────────────────────────────────────────────────────┐
78		│ krz.sh │
79		└──────────────────────────────────────────────────────────────┘

README.org added +87

		@@ -0,0 +1,87 @@
	1	#+title: brand bench
	2
	3	* what
	4	client-side brand identity generator. describe a project, get a
	5	brand package: positioning, tone, color palette, typography, logo
	6	concepts, taglines, usage examples. runs in the browser.
	7
	8	no backend. no accounts. state persists in localStorage.
	9
	10	* does
	11	- template generation, offline, tailored by category
	12	- ai generation via a local ollama instance, cancellable mid-stream
	13	- multiple packages in tabs, each persisted separately
	14	- inline editing, click any field in the preview
	15	- section locking across regenerations
	16	- undo/redo per package (⌘Z / ⌘⇧Z)
	17	- editable color swatches, native color picker
	18	- font pairings per category, 8-level type scale
	19	- export to markdown, json, or a self-contained html page
	20
	21	* run
	22	#+begin_src sh
	23	npm install
	24	npm run dev
	25	#+end_src
	26
	27	open http://localhost:5173.
	28
	29	- build:
	30
	31	#+begin_src sh
	32	npm run build # dist/
	33	npm run preview
	34	#+end_src
	35
	36	* ai with ollama
	37	1. install ollama, pull a model:
	38
	39	#+begin_src sh
	40	ollama pull llama3.2
	41	ollama pull mistral
	42	ollama pull gemma3
	43	#+end_src
	44
	45	2. run it:
	46
	47	#+begin_src sh
	48	ollama serve
	49	#+end_src
	50
	51	3. a non-default host or port needs OLLAMA_ORIGINS set for browser
	52	requests:
	53
	54	#+begin_src conf
	55	OLLAMA_ORIGINS="*" ollama serve
	56	#+end_src
	57
	58	4. in the app: Settings, enable AI, set base url
	59	(http://localhost:11434), pick a model, Test connection.
	60
	61	bigger models give better-structured output. generation takes
	62	15-60s depending on hardware.
	63
	64	* docker
	65	Dockerfile and compose.yml deploy the app next to ollama.
	66
	67	#+begin_src sh
	68	docker compose up -d --build
	69	#+end_src
	70
	71	app serves on port 8000. ollama's api is proxied through nginx at
	72	/api/, so the browser makes no cross-origin request. after first
	73	boot, pull a model:
	74
	75	#+begin_src sh
	76	docker compose exec ollama ollama pull llama3.2
	77	#+end_src
	78
	79	set the ollama base url to http://your-server:8000. for an nvidia
	80	gpu, uncomment the deploy block in compose.yml (needs the nvidia
	81	container toolkit).
	82
	83	* stack
	84	react 18, typescript, vite. no ui library, plain css.
	85
	86	* license
	87	0bsd. see LICENSE.