Skip to content

Commit 7abc6fb

Browse files
committed
Modified mac and linux documentation
1 parent 5fa33a2 commit 7abc6fb

File tree

2 files changed

+31
-10
lines changed

2 files changed

+31
-10
lines changed

docs/build/build_agent_linux_macos.md renamed to docs/build/build_agent_linux.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Building the yCrash Agent on Linux and macOS
1+
# Building the yCrash Agent on Linux
22

3-
This guide outlines the steps to build the yCrash agent in both Linux and macOS environments. You have two options for building the agent:
3+
This guide outlines the steps to build the yCrash agent in Linux environment. You have two options for building the agent:
44

55
1) Build via Dockerized Environment (Recommended)
66
2) Build on Bare Metal
@@ -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
@@ -85,15 +85,14 @@ If you prefer building the agent directly on your local system, ensure the follo
8585
- ncurses-libs
8686
- ncurses-static
8787

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

docs/build/build_agent_macos.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Building the yCrash Agent on macOS
2+
3+
This guide outlines the steps to build the yCrash agent in macOS environments.
4+
5+
---
6+
Ensure the following packages are installed.
7+
8+
**Required Packages:**
9+
- go
10+
- git
11+
12+
## Build yCrash Agent
13+
14+
### Step 1: Navigate to the `cmd/yc` directory inside the repository:
15+
```
16+
cd ../yc-data-script/cmd/yc
17+
```
18+
### Step 2: Then run the following command to build the agent:
19+
```
20+
go build -o yc -ldflags='-s -w' -buildvcs=false
21+
```
22+
Once the build is completed, the yc binary will be available in the `../yc-data-script/bin/` directory.

0 commit comments

Comments
 (0)