Installation Guide
This guide will walk you through installing Twinkies from source. Building from source gives you the latest features and allows you to customize the compiler.
Prerequisites
Before building Twinkies, ensure you have the following installed:
Required Tools
- C Compiler: GCC 15+ (download from w64devkit)
- Build System: Make 4.4.1 or later
- Git: For cloning the repository
- Make: (download from w64devkit)
Building from Source
Step 1: Clone the Repository
git clone https://github.com/m512i/twinkies.git
cd twinkies
Step 2: Create Build Directory
mkdir build
Step 3: Configure with Make
make
Verification
After building, verify the installation:
# Check if the compiler is in your PATH
twinkies --version
# Or run directly from build directory
./twinkies --version
You should see output similar to:
Twinkies Compiler v1.0.0
Testing Your Installation
Create a simple test program:
// test.tl
func main() -> int {
print("Hello, Twinkies!");
return 0;
}
Compile and run:
twinkies test.tl -o test
./test
Expected output:
Hello, Twinkies!
Output Formats
The compiler supports multiple output formats:
# Transpile to C (default)
twinkies input.tl -o output.c
# Compile to assembly
twinkies input.tl -S -o output.s
# Compile directly to executable
twinkies input.tl -o output.exe
"Make not found"
Install Make:
- Windows: (download from w64devkit)
"C compiler not found"
Ensure you have a C/C++ compiler installed:
- Windows: GCC (download from w64devkit)
Compiler Not Found After Installation
Windows:
- Open System Properties → Environment Variables
- Add the installation directory to PATH
- Restart your terminal
Next Steps
After installation:
- Read the Language Overview to get started
- Check out the Examples Guide for sample programs
- Refer to the Quick Reference for syntax help
Getting Help
- GitHub Issues: Report bugs or request features
- Discord: Join our Discord server for community support
- Documentation: Browse the full documentation index
