Merge pull request #9 from carloscasalar/5-add-a-screen-recording-to-…

…the-readme-showcasing-the-generate-npc-cli-command

🍿Add a make command to generate the demo gif

.gitignore

@@ -1,2 +1,3 @@
 .idea
 out
+.DS_Store

Makefile

@@ -1,5 +1,8 @@
 # Define the binary name
 BINARY_NAME=./out/generate-npc
+BINARY_DEMO_NAME=./demo/generate-npc
+
+DEMO_ASSETS=demo/assets
 
 # Define the main package
 MAIN_PACKAGE=./cmd/generate-npc
@@ -21,6 +24,12 @@ install-tools:
 build: out
 	@go build -o $(BINARY_NAME) $(MAIN_PACKAGE)
 
+# Build binary to generate the demo.gif inside the vhs docker container
+build-demo: out
+	env GOOS=linux go build -o $(BINARY_DEMO_NAME) $(MAIN_PACKAGE)
+	mkdir -p $(DEMO_ASSETS)
+	cp assets/* $(DEMO_ASSETS)
+
 # Run the Go application
 run: build
 	$(BINARY_NAME) $(filter-out $@,$(MAKECMDGOALS))
@@ -36,9 +45,14 @@ lint:
 # Run all checks
 check: lint test
 
+save-demo-gif: build-demo
+	docker run --rm -v ${PWD}/demo:/vhs ghcr.io/charmbracelet/vhs demo.tape
+
 # Clean up build artifacts
 clean:
 	rm -f $(BINARY_NAME)
+	rm -f $(BINARY_DEMO_NAME)
+	rm -rf $(DEMO_ASSETS)
 
 # Default target
 all: build

README.md

@@ -37,3 +37,21 @@ According to the previous experience of the NPC, the generator will assign a num
 <tr> <td>Elite</td> <td>1</td> <td>2</td> <td>3</td> <td>6</td> </tr>
 </tbody> 
 </table>
+
+## Build & Run
+
+To build the project execute the following command:
+
+```bash
+make build
+```
+
+This will generate this binary `out/generate-npc`. 
+
+To run the project execute the following command:
+
+```bash
+./out/generate-npc --help
+```
+
+<img src="demo/demo.gif" alt="Demo" />

demo/.gitignore

@@ -0,0 +1,3 @@
+assets/
+*.ascii
+generate-npc

demo/README.md

@@ -0,0 +1,7 @@
+# Demo
+
+This folder is to generate and store the demo files. To generate the demo gif, go to the repo root directory and type
+
+```bash
+make save-demo-gif
+```

demo/demo.tape

@@ -0,0 +1,18 @@
+# Where should we write the GIF?
+Output demo.gif
+
+Set FontSize 12
+Set Width 900
+Set Height 550
+Set TypingSpeed 200ms
+Set Theme "Catppuccin Frappe"
+Set Margin 20
+Set BorderRadius 10
+Set MarginFill "#6B50FF"
+Set WindowBar Colorful
+
+# Type a command in the terminal.
+Type "./generate-npc -r pilot"
+Show
+Enter
+Sleep 15s