summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9245763
--- /dev/null
+++ b/README.md
@@ -0,0 +1,34 @@
+[![progress-banner](https://backend.codecrafters.io/progress/claude-code/f722fdbd-6b3b-465b-aa09-ade680ac88d7)](https://app.codecrafters.io/users/codecrafters-bot?r=2qF)
+
+This is a starting point for Zig solutions to the
+["Build Your own Claude Code" Challenge](https://codecrafters.io/challenges/claude-code).
+
+Claude Code is an AI coding assistant that uses Large Language Models (LLMs) to
+understand code and perform actions through tool calls. In this challenge,
+you'll build your own Claude Code from scratch by implementing an LLM-powered
+coding assistant.
+
+Along the way you'll learn about HTTP RESTful APIs, OpenAI-compatible tool
+calling, agent loop, and how to integrate multiple tools into an AI assistant.
+
+**Note**: If you're viewing this repo on GitHub, head over to
+[codecrafters.io](https://codecrafters.io) to try the challenge.
+
+# Passing the first stage
+
+The entry point for your `claude-code` implementation is in `src/main.zig`.
+Study and uncomment the relevant code, and submit to pass the first stage:
+
+```sh
+codecrafters submit
+```
+
+# Stage 2 & beyond
+
+Note: This section is for stages 2 and beyond.
+
+1. Ensure you have `zig (0.15)` installed locally.
+2. Run `./your_program.sh` to run your program, which is implemented in
+ `src/main.zig`.
+3. Run `codecrafters submit` to submit your solution to CodeCrafters. Test
+ output will be streamed to your terminal.