Skip to content

Commit 5fa33a2

Browse files
committed
Format issue fixed
1 parent 863a8de commit 5fa33a2

File tree

2 files changed

+16
-15
lines changed

2 files changed

+16
-15
lines changed

docs/build/build_agent_linux_macos.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ This guide outlines the steps to build the yCrash agent in both Linux and macOS
99

1010
This method uses an Alpine-based Docker image to set up a clean Go development environment with all required dependencies.
1111

12-
#### Step 1: Create a Dockerfile
12+
### Step 1: Create a Dockerfile
1313

1414
Create a `Dockerfile.base.alpine` and add the following content:
1515

@@ -34,7 +34,7 @@ WORKDIR /opt/workspace/yc-agent
3434

3535
ENTRYPOINT ["/bin/sh"]
3636
```
37-
#### Step 2: Create a Makefile
37+
### Step 2: Create a Makefile
3838
To simplify the build process, create a `Makefile` and add the following content:
3939

4040
```makefile
@@ -61,7 +61,7 @@ shell:
6161
build:
6262
docker exec -it yc-agent-alpine /bin/sh -c "cd cmd/yc && go build -o yc -ldflags='-s -w' -buildvcs=false && mkdir -p ../../bin/ && mv yc ../../bin/"
6363
```
64-
#### Step 3: Build the Agent
64+
### Step 3: Build the Agent
6565
To build the agent using the containerized environment, run the following command:
6666
```
6767
sudo make alpine base build
@@ -87,12 +87,13 @@ If you prefer building the agent directly on your local system, ensure the follo
8787

8888
> 📌 **Note**: Package names may vary slightly depending on your Linux distribution or macOS package manager (e.g., Homebrew).
8989
90-
### Build Steps:
91-
#### Step 1: Navigate to the cmd/yc directory inside the repository:
90+
## Build Steps:
91+
92+
### Step 1: Navigate to the cmd/yc directory inside the repository:
9293
```
9394
cd ../yc-data-script/cmd/yc
9495
```
95-
#### Step 2: Then run the following command to build the agent:
96+
### Step 2: Then run the following command to build the agent:
9697
```
9798
go build -o yc -ldflags='-s -w' -buildvcs=false && mkdir -p ../../bin/ && mv yc ../../bin/
9899
```

docs/build/build_agent_windows.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
This guide provides step-by-step instructions to build the **yCrash agent** on a Windows machine. The agent includes Go and C code, so it requires a proper toolchain setup.
44

5-
#### Step 1: Download MSYS2
5+
### Step 1: Download MSYS2
66

77
**MSYS2** is a software distribution and development platform for Windows that provides a Unix-like shell and access to commonly used Linux development tools through its `pacman` package manager.
88

99
👉 Download the MSYS2 installer from [here](https://github.com/msys2/msys2-installer/releases/download/2021-07-25/msys2-x86_64-20210725.exe).
1010

11-
#### Step 2: Install MSYS2
11+
### Step 2: Install MSYS2
1212
- Double-click the downloaded `.exe` file to launch the installation wizard.
1313
- Choose the installation path (e.g., `C:\msys64`) and click **Next**.
1414
- Continue with the default settings and click **Next** through each step until you reach the final screen.
@@ -17,7 +17,7 @@ This guide provides step-by-step instructions to build the **yCrash agent** on a
1717
![img](/docs/images/installation-folder.png)
1818

1919
Proceed to the next step once the **MSYS2** windows is opened.
20-
#### Step 3: Install/Update Package Database
20+
### Step 3: Install/Update Package Database
2121
>💡**What is package database?**
2222
>
2323
>The package database is a local index maintained by `pacman`. It tracks:
@@ -33,14 +33,14 @@ packman -Syu
3333

3434
When you get an output as shown in the above screenshot, close the window and reopen it by searching **MSYS2 MSYS** using Windows search.
3535

36-
#### Step 4: Install/Update Base Package
36+
### Step 4: Install/Update Base Package
3737
Once the terminal is reopened, upgrade base packages by running:
3838
```
3939
packman -Su
4040
```
4141
![img](/docs/images/update-package.png)
4242

43-
#### Step 5: Install MinGW-w64
43+
### Step 5: Install MinGW-w64
4444

4545
> ### 💡 **What is MinGW-w64?**
4646
>
@@ -60,15 +60,15 @@ pacman -S --needed base-devel mingw-w64-x86_64-toolchain
6060

6161
Once installed, **close and reopen** the MSYS2 terminal again (same as before).
6262

63-
#### Step 6: Install MinGW-w64 Go Package
63+
### Step 6: Install MinGW-w64 Go Package
6464

6565
Install the Go toolchain for building native Windows 64-bit binaries:
6666
```
6767
pacman -S mingw-w64-x86_64-go
6868
```
6969
After installation, close the MSYS2 terminal.
7070

71-
#### Step 7: Set Envrionment Variable
71+
### Step 7: Set Envrionment Variable
7272
To enable access to the installed tools from any terminal or build script:
7373

7474
1. Open **System Environment Variables** (search "Edit environment variables" in the Start menu).
@@ -81,7 +81,7 @@ To enable access to the installed tools from any terminal or build script:
8181
- `GOPATH = C:\msys64\mingw64\go`
8282
- `GOROOT = <Go installation path>` (e.g., `C:\Program Files\Go`)
8383

84-
#### Step 9: Verify Installation
84+
### Step 9: Verify Installation
8585

8686
Open a Command Prompt and run:
8787
```
@@ -90,7 +90,7 @@ gcc --version
9090
You should see the installed GCC version:
9191
![img](/docs/images/gcc-version.png)
9292

93-
#### Step 9: Build yCrash Agent
93+
### Step 9: Build yCrash Agent
9494
Once everything is set up, navigate to the yCrash agent source directory `yc-data-script/cmd/yc` and run:
9595
```
9696
go build

0 commit comments

Comments
 (0)