docs: updated readme with wip

Author: Sheape

README.md

@@ -1,51 +1,27 @@
-[![progress-banner](https://backend.codecrafters.io/progress/interpreter/af5c17e1-59fc-408b-a0ef-45ad80261545)](https://app.codecrafters.io/users/codecrafters-bot?r=2qF)
-
-This is a starting point for Rust solutions to the
-["Build your own Interpreter" Challenge](https://app.codecrafters.io/courses/interpreter/overview).
-
-This challenge follows the book
-[Crafting Interpreters](https://craftinginterpreters.com/) by Robert Nystrom.
-
-In this challenge you'll build an interpreter for
-[Lox](https://craftinginterpreters.com/the-lox-language.html), a simple
-scripting language. Along the way, you'll learn about tokenization, ASTs,
-tree-walk interpreters and more.
-
-Before starting this challenge, make sure you've read the "Welcome" part of the
-book that contains these chapters:
-
-- [Introduction](https://craftinginterpreters.com/introduction.html) (chapter 1)
-- [A Map of the Territory](https://craftinginterpreters.com/a-map-of-the-territory.html)
-  (chapter 2)
-- [The Lox Language](https://craftinginterpreters.com/the-lox-language.html)
-  (chapter 3)
-
-These chapters don't involve writing code, so they won't be covered in this
-challenge. This challenge will start from chapter 4,
-[Scanning](https://craftinginterpreters.com/scanning.html).
-
-**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 program is in `src/main.rs`. 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 `cargo (1.86)` installed locally
-2. Run `./your_program.sh` to run your program, which is implemented in
-   `src/main.rs`. This command compiles your Rust project, so it might be slow
-   the first time you run it. Subsequent runs will be fast.
-3. Commit your changes and run `git push origin master` to submit your solution
-   to CodeCrafters. Test output will be streamed to your terminal.
+<div align="center">
+  <img src="https://github.com/user-attachments/assets/c897b8e9-a218-47a9-a25e-d19add09c36e" alt="Fox" width="100%" />
+
+  ![Rust version](https://img.shields.io/badge/cargo-v1.86.0-f64d00)
+</div>
+
+## Overview
+`Fox` is a fast Lox interpreter written in rust based from the specifications in the [Lox](https://craftinginterpreters.com/the-lox-language.html) programming language by Robert Nystrom. Lox is known as a dynamic scripting language but with some OOP aspects like classes and inheritance. Imports are **not** included in this interpreter, however it's easy to add given the structure of the code.
+
+## Features
+- [x] High Performance Lexer and Parser
+- [x] Evaluating Expressions with Order (using Recursive Descent Parsing Algorithm)
+- [x] Useful Error Messages
+- [ ] Variable declaration
+- [ ] Scoping
+- [ ] Functions
+- [ ] Classes & OOP
+- [ ] REPL
+
+## Setup
+1. Clone this repository.
+2. Install [the rust toolchain](https://www.rust-lang.org/tools/install) version `1.86.0`.
+3. Build the projcet with `cargo build` or if you are in release mode, `cargo build --release`.
+4. Run the interpreter with either the following subcommands depending on the output that you want: `tokenize` (lexer), `parse` (parser), or `evaluate` (evaluator). `cargo run <subcommand> <file_name>`.
+
+## WIP
+While this is a working interpreter at the moment, I wanted to finish it as a usable complete day-to-day interpreter that you would actually use. Providing a good developer experience is key to a good interpreter. Some features that I will definitely implement are pretty error messages, interactive REPL, and maybe in the future an LSP server with treesitter.