Skip to content

Commit c89048b

Browse files
committed
Update README
1 parent 8d17406 commit c89048b

File tree

1 file changed

+67
-20
lines changed

1 file changed

+67
-20
lines changed

README.md

Lines changed: 67 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -48,26 +48,27 @@ The tool intelligently processes a local folder or a public GitHub repository, i
4848

4949
### From Source
5050

51-
1. Clone the repository:
51+
1. Clone the repository:
5252

53-
```bash
54-
git clone https://github.com/alexferrari88/code2context.git
55-
cd code2context
56-
```
53+
```bash
54+
git clone https://github.com/alexferrari88/code2context.git
55+
cd code2context
56+
```
5757

58-
2. Build the executable:
58+
2. Build the executable:
5959

60-
```bash
61-
go build -o c2c ./main.go
62-
```
60+
```bash
61+
go build -o c2c ./main.go
62+
```
6363

64-
3. (Optional) Move the `c2c` executable to a directory in your system's PATH, for example:
65-
```bash
66-
sudo mv c2c /usr/local/bin/
67-
# or for a local user path
68-
# mkdir -p ~/bin && mv c2c ~/bin
69-
# (ensure ~/bin is in your PATH)
70-
```
64+
3. (Optional) Move the `c2c` executable to a directory in your system's PATH, for example:
65+
66+
```bash
67+
sudo mv c2c /usr/local/bin/
68+
# or for a local user path
69+
# mkdir -p ~/bin && mv c2c ~/bin
70+
# (ensure ~/bin is in your PATH)
71+
```
7172

7273
### Using `go install` (Recommended for Go users)
7374

@@ -77,10 +78,56 @@ go install github.com/alexferrari88/code2context@latest
7778

7879
This will download, compile, and install the `c2c` binary into your `$GOPATH/bin` or `$GOBIN` directory. Ensure this directory is in your system's PATH.
7980

80-
<!--
81-
### Pre-compiled Binaries (Coming Soon!)
82-
Once releases are available, you can download pre-compiled binaries for your operating system from the [Releases page](https://github.com/alexferrari88/code2context/releases).
83-
-->
81+
### Prebuilt Binaries
82+
83+
Prebuilt executables for **macOS (x64/arm64)** and **Linux (x64)** are available on the [Releases page](https://github.com/alexferrari88/code2context/releases).
84+
85+
> **Note:** Windows and Linux on ARM64 binaries are not yet provided. If you’re proficient with GitHub Actions and would like to help add these targets, please propose changes to the [release workflow](https://github.com/alexferrari88/code2context/blob/main/.github/workflows/release.yml) and open a pull request.
86+
87+
### Adding to PATH
88+
89+
Once you've downloaded the appropriate binary for your platform, add it to your system `PATH` so you can run `c2c` from any terminal.
90+
91+
#### Linux and macOS
92+
93+
1. Make the binary executable:
94+
95+
```bash
96+
chmod +x c2c
97+
```
98+
99+
2. Move it to a directory in your PATH (for example `/usr/local/bin`):
100+
101+
```bash
102+
sudo mv c2c /usr/local/bin/
103+
```
104+
105+
Alternatively, for a user-local install:
106+
107+
```bash
108+
mkdir -p ~/bin
109+
mv c2c ~/bin
110+
# Ensure ~/bin is in your PATH (e.g., add `export PATH="$HOME/bin:$PATH"` to your shell profile)
111+
```
112+
113+
#### Windows
114+
115+
1. Rename the downloaded executable to `c2c.exe` (if necessary).
116+
117+
2. Move it to a permanent directory, for example `C:\tools\c2c`, and then add that directory to your system `PATH`:
118+
119+
* Open **System Properties** > **Advanced** > **Environment Variables**.
120+
* Under **User variables** or **System variables**, select `Path` and click **Edit**.
121+
* Click **New**, then enter `C:\tools\c2c` (or your chosen folder).
122+
* Click **OK** to apply.
123+
124+
Or, in PowerShell (as administrator):
125+
126+
```powershell
127+
setx PATH $env:PATH + ";C:\tools\c2c"
128+
```
129+
130+
After that, you can run `c2c` from any terminal.
84131

85132
## Usage
86133

0 commit comments

Comments
 (0)