diff --git a/docs/README.md b/docs/README.md index 5ac155b..97c77d7 100644 --- a/docs/README.md +++ b/docs/README.md @@ -30,12 +30,50 @@ Femcode is a femboy-themed programming language designed to be simple, expressiv ## 1. Getting Started -To run Femcode programs, you need the Femcode interpreter. Navigate to the `femcode/src` directory and run `main.py` with your Femcode file. +To run Femcode programs, you can use the `femterpreter` wrapper script. This script simplifies running your `.fem` files without needing to navigate to the `src` directory or explicitly call `python3 main.py`. + +### Running Femcode Programs + +Once you have the `femterpreter` script, you can run your Femcode programs like this: ```bash -python3 main.py ../examples/your_program.fem +./femterpreter examples/your_program.fem ``` +Or, if you add `femterpreter` to your system's PATH or create an alias (recommended for convenience): + +```bash +femterpreter examples/your_program.fem +``` + +### Setting up `femterpreter` (Optional, but Recommended) + +To use `femterpreter` from any directory, you can either add it to your system's PATH or create a shell alias. + +**Option 1: Add to PATH** + +1. Open your shell's configuration file (e.g., `~/.bashrc`, `~/.zshrc`, or `~/.profile`). +2. Add the following line, replacing `/path/to/femboy-coding-language` with the actual absolute path to your `femboy-coding-language` directory: + + ```bash + export PATH="/path/to/femboy-coding-language/femcode:$PATH" + ``` + +3. Save the file and restart your terminal or run `source ~/.bashrc` (or your respective config file). + +**Option 2: Create an Alias** + +1. Open your shell's configuration file (e.g., `~/.bashrc`, `~/.zshrc`, or `~/.profile`). +2. Add the following line, replacing `/path/to/femboy-coding-language` with the actual absolute path to your `femboy-coding-language` directory: + + ```bash + alias femterpreter="/path/to/femboy-coding-language/femcode/femterpreter" + ``` + +3. Save the file and restart your terminal or run `source ~/.bashrc` (or your respective config file). + +## 2. Basic Syntax + ## 2. Basic Syntax Femcode uses keywords inspired by femboy terminology. Code blocks are defined using `Femboycore` to start a block and `Periodt` to end it.