diff --git a/README.md b/README.md index bf9d942..88382f1 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,36 @@ -# PCCCompiler +# PCC Compiler (My C++ Compiler) +![Version](https://img.shields.io/badge/version-0.0.2-blue.svg) +![Status](https://img.shields.io/badge/status-BETA-orange.svg) +![Language](https://img.shields.io/badge/language-C%2B%2B-00599C.svg) +![Platform](https://img.shields.io/badge/platform-Windows%20x64-lightgrey.svg) + +**PCC Compiler** is a custom programming language compiler built from scratch in C++. It translates PCC code into x64 Assembly (NASM), which is then linked into a standalone Windows executable. + +This project was developed as a holiday project for the Masovian Voivodeship coding challenge. + +## 🚀 Features + +- **Custom Syntax**: C-like syntax easy for beginners. +- **Variables**: Support for `int` and `bool` types. +- **Control Flow**: `if` statements support. +- **Functions**: Define and call `void` functions. +- **Math Operations**: Basic arithmetic (`+`, `-`, `==`). +- **Native Compilation**: Compiles directly to machine code (via NASM). + +## 🛠️ Installation & Usage + +### Prerequisites +To compile code, you need: +- **NASM** (Netwide Assembler) +- **GoLink** (Linker) +- *Note: These tools must be added to your system PATH.* + +### Quick Start +1. Download the latest release from the [Releases](../../releases) page. +2. Unzip the archive. +3. Run `start.bat` as **Administrator**. +4. Use the compiler in the terminal: + +```powershell +PCC.exe my_script.pcc