init [skip ci]

1 files changed, 34 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2612ba9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,34 @@
+[![progress-banner](https://backend.codecrafters.io/progress/shell/38e570f4-0f52-40ff-8f0d-1d95e3edeb1c)](https://app.codecrafters.io/users/codecrafters-bot?r=2qF)
+
+This is a starting point for Zig solutions to the
+["Build Your Own Shell" Challenge](https://app.codecrafters.io/courses/shell/overview).
+
+In this challenge, you'll build your own POSIX compliant shell that's capable of
+interpreting shell commands, running external programs and builtin commands like
+cd, pwd, echo and more. Along the way, you'll learn about shell command parsing,
+REPLs, builtin commands, and more.
+
+**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 `shell` implementation is in `src/main.zig`. Study and
+uncomment the relevant code, and push your changes to pass the first stage:
+
+```sh
+git commit -am "pass 1st stage" # any msg
+git push origin master
+```
+
+Time to move on to the next stage!
+
+# Stage 2 & beyond
+
+Note: This section is for stages 2 and beyond.
+
+1. Ensure you have `zig (0.15)` installed locally
+1. Run `./your_program.sh` to run your program, which is implemented in
+   `src/main.zig`.
+1. Commit your changes and run `git push origin master` to submit your solution
+   to CodeCrafters. Test output will be streamed to your terminal.