Skip to content

Commit a653eeb

Browse files
authored
Update README.md
Signed-off-by: Brainy7980 <bpurdy12@icloud.com>
1 parent 025af39 commit a653eeb

1 file changed

Lines changed: 117 additions & 0 deletions

File tree

README.md

Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,120 @@ Secondly, download the source code from here.
1414
Now, finally, run the `setup.py` file inside of Python. It will ask for things and then you can use the `bsc` command to compile BScript files! Neat!
1515

1616
Or, just download the GUI app if you prefer. It's completely self-contained and required no dependencies.
17+
18+
## Requirements
19+
20+
## SDL2
21+
22+
To compile programs that use the `window;` command in BScript, you need SDL2 installed.
23+
24+
<details>
25+
<summary><strong>Windows</strong></summary>
26+
27+
Using MSYS2:
28+
29+
```bash
30+
pacman -S mingw-w64-x86_64-SDL2
31+
```
32+
33+
Make sure you're using the **MSYS2 MinGW 64-bit** terminal, and that `C:\msys64\mingw64\bin` is in your PATH.
34+
35+
</details>
36+
37+
<details>
38+
<summary><strong>macOS</strong></summary>
39+
40+
Install Homebrew if you haven't already:
41+
42+
```bash
43+
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
44+
```
45+
46+
Then install SDL2 via Homebrew:
47+
48+
```bash
49+
brew install sdl2
50+
```
51+
52+
</details>
53+
54+
<details>
55+
<summary><strong>Linux (Debian/Ubuntu)</strong></summary>
56+
57+
```bash
58+
sudo apt update
59+
sudo apt install libsdl2-dev
60+
```
61+
62+
</details>
63+
64+
<details>
65+
<summary><strong>Linux (Fedora/RHEL)</strong></summary>
66+
67+
```bash
68+
sudo dnf install SDL2-devel
69+
```
70+
71+
</details>
72+
73+
74+
### GCC Compiler
75+
76+
BScript uses **GCC** (or compatible C compiler) to compile transpiled code. Please ensure it's installed on your system.
77+
78+
<details>
79+
<summary><strong>macOS</strong></summary>
80+
81+
- Install **Xcode Command Line Tools**:
82+
83+
```bash
84+
xcode-select --install
85+
```
86+
87+
- This will give you `gcc` (which points to Clang, and works fine for most C programs).
88+
</details>
89+
90+
<details>
91+
<summary><strong>Linux (Debian/Ubuntu/Fedora/Arch)</strong></summary>
92+
93+
- On Debian/Ubuntu:
94+
95+
```bash
96+
sudo apt update
97+
sudo apt install build-essential
98+
```
99+
100+
- On Fedora:
101+
102+
```bash
103+
sudo dnf groupinstall "Development Tools"
104+
```
105+
106+
- On Arch Linux:
107+
108+
```bash
109+
sudo pacman -S base-devel
110+
```
111+
112+
</details>
113+
114+
<details>
115+
<summary><strong>Windows</strong></summary>
116+
117+
#### Option 1: MSYS2 (Recommended)
118+
1. Download and install: [https://www.msys2.org](https://www.msys2.org)
119+
2. Open the **MSYS2 MinGW 64-bit** terminal.
120+
3. Run:
121+
122+
```bash
123+
pacman -S mingw-w64-x86_64-gcc
124+
```
125+
126+
> Make sure to add `C:\msys64\mingw64\bin` to your system PATH.
127+
128+
#### Option 2: MinGW (Standalone)
129+
1. Download from: [https://osdn.net/projects/mingw/releases/](https://osdn.net/projects/mingw/releases/)
130+
2. Select the `mingw32-gcc-g++` package in the installer.
131+
3. Add `C:\MinGW\bin` to your PATH environment variable.
132+
133+
</details>

0 commit comments

Comments
 (0)