Skip to content

Commit

Permalink
Merge pull request #171 from KennyOliver/issue-154
Browse files Browse the repository at this point in the history
Add: Installation instructions to `README.md`
  • Loading branch information
KennyOliver authored Jan 3, 2025
2 parents 7c67584 + 3fde2c6 commit 2449f71
Showing 1 changed file with 52 additions and 0 deletions.
52 changes: 52 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,12 +70,64 @@ FlavorLang blends coding with culinary creativity! Write programs like recipes &

### 1. Install the Compiler

<details>
<summary>
<h4>Make it yourself</h4>
</summary>

```bash
$ git clone https://github.com/KennyOliver/FlavorLang.git
$ cd src
$ make
```

</details>

#### For macOS Users

##### 1. Download & Extract the ZIP

[FlavorLang Releases](https://github.com/KennyOliver/FlavorLang/releases)

##### 2. Run the Install Script

<!-- chmod +x install.sh -->

```bash
./install.sh
```

##### 3. Handle macOS Security Prompt (If Any)

- If macOS prompts a security warning, navigate to <kbd>System Preferences</kbd> > <kbd>Security & Privacy</kbd> > <kbd>General</kbd>.
- Click "Open Anyway" for `flavor`.

##### 4. Verify Installation

```bash
flavor --about
```

#### For Ubuntu Users

##### 1. Download & Extract the ZIP

[FlavorLang Releases](https://github.com/KennyOliver/FlavorLang/releases)

##### 2. Run the Install Script

<!-- chmod +x install.sh -->

```bash
./install.sh
```

##### 3. Verify Installation

```bash
flavor --about
```

### 2. Write Your First Recipe

```py
Expand Down

0 comments on commit 2449f71

Please sign in to comment.