Skip to content

Commit fde9a95

Browse files
authored
Update AGENTS.md
1 parent c0f5d5e commit fde9a95

File tree

1 file changed

+59
-36
lines changed

1 file changed

+59
-36
lines changed

AGENTS.md

Lines changed: 59 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,61 @@
11
# AGENTS Setup Guide
22

3-
This repository requires environment configuration to build and run the .NET 9.0 projects. Run the installation script below with **sudo** or **root** privileges.
4-
5-
## Steps in `setup.sh`
6-
7-
1. Update and upgrade the system:
8-
```bash
9-
apt-get update && apt-get upgrade -y
10-
```
11-
2. Install basic dependencies (`wget`, `apt-transport-https`, `ca-certificates`):
12-
```bash
13-
apt-get install -y wget apt-transport-https ca-certificates
14-
```
15-
3. Add the Microsoft package key and update package lists:
16-
```bash
17-
wget https://packages.microsoft.com/config/ubuntu/$(lsb_release -rs)/packages-microsoft-prod.deb
18-
dpkg -i packages-microsoft-prod.deb
19-
apt-get update
20-
```
21-
4. Install **.NET SDK 9.0**:
22-
```bash
23-
apt-get install -y dotnet-sdk-9.0
24-
```
25-
Verify the installation:
26-
```bash
27-
dotnet --version
28-
```
29-
5. (Optional) Remove old packages:
30-
```bash
31-
apt-get autoremove -y
32-
```
33-
34-
## Notes from the README
35-
36-
- Use the latest version of **Visual Studio** or **Visual Studio Code**.
37-
- Ensure the matching runtime version of the SDK is installed as indicated by the project.
38-
- You can also run the Equinox Project in Visual Studio Code on Windows, Linux or macOS.
3+
This repository requires specific environment configuration to build and run .NET 9.0 projects. **All dependencies must be installed during the setup script phase,** especially in restricted environments (e.g., OpenAI Codex).
4+
5+
## Setup Steps (`setup.sh`)
6+
7+
1. **Update and upgrade the system:**
8+
9+
`apt-get update && apt-get upgrade -y`
10+
11+
2. **Install essential dependencies (`wget`, `apt-transport-https`, `ca-certificates`):**
12+
13+
`apt-get install -y wget apt-transport-https ca-certificates`
14+
15+
3. **Configure Microsoft package source and update package lists:**
16+
17+
`wget https://packages.microsoft.com/config/ubuntu/$(lsb_release -rs)/packages-microsoft-prod.deb -O packages-microsoft-prod.deb`
18+
19+
`dpkg -i packages-microsoft-prod.deb`
20+
21+
`rm packages-microsoft-prod.deb`
22+
23+
`apt-get update`
24+
25+
4. **Install .NET SDK 9.0:**
26+
27+
`apt-get install -y dotnet-sdk-9.0`
28+
29+
5. **Verify installation:**
30+
31+
`dotnet --version`
32+
33+
6. **(Optional) Remove obsolete packages:**
34+
35+
`apt-get autoremove -y`
36+
37+
38+
---
39+
40+
## ⚠️ Notes for Codex and Similar Cloud Environments
41+
42+
- **Internet access is only available during the setup script phase.** All dependencies must be installed in this initial script.
43+
- **A network proxy is always active:** Standard environment variables like `http_proxy`, `https_proxy`, and the proxy certificate (`$CODEX_PROXY_CERT`) are automatically set. These should be respected by all package managers and CLI tools.
44+
- **If you encounter connectivity issues:**
45+
- Ensure your setup script is running during the setup/initialization phase (not in the regular terminal).
46+
- Check that all required dependencies are installed up front.
47+
- Make sure environment variables for the proxy/certificate are being used by your tools.
48+
49+
---
50+
51+
## General Recommendations
52+
53+
- Use the latest version of **Visual Studio** or **Visual Studio Code** for development.
54+
- Always install the correct SDK and runtime versions as required by this project.
55+
- The project can be built and run in Visual Studio Code on Windows, Linux, or macOS.
56+
57+
---
58+
59+
**IMPORTANT:**
60+
61+
If using a cloud development platform or automated environment, ensure all tools and dependencies are installed during the setup script phase. No additional internet access will be available after environment initialization. Plan accordingly.

0 commit comments

Comments
 (0)