Skip to content

Commit 6a44041

Browse files
Update build.md
1 parent f05c779 commit 6a44041

1 file changed

Lines changed: 28 additions & 23 deletions

File tree

build.md

Lines changed: 28 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,49 @@
11
# Building P4Ruby from Source
22

33

4-
Note: Make sure you have following packages installed on your system:
5-
a. build-essential
6-
b. libssl-dev
4+
1. Make sure you have following packages installed on your system:\
5+
a. build-essential\
6+
b. libssl-dev
77

8-
1. Download the Perforce C++ API from the Perforce FTP site at
9-
<ftp://ftp.perforce.com/perforce> . \
8+
2. Download the Perforce C++ API from the Perforce FTP site at
9+
<https://ftp.perforce.com/perforce>. \
1010
The API archive is located in release and platform-specific subdirectories and is named
1111
*"p4api-glibc2.3-openssl1.1.1.tgz".*
1212

13-
**Note: 32-bit builds of P4Ruby require a 32-bit version of the C++ API and a 32-bit version of Ruby.\
14-
           64-bit builds of P4Ruby require a 64-bit version of the C++ API and a 64-bit version of Ruby.**
13+
**Note:** 32-bit builds of P4Ruby require a 32-bit version of the C++ API and a 32-bit version of Ruby.\
14+
           64-bit builds of P4Ruby require a 64-bit version of the C++ API and a 64-bit version of Ruby.
1515

1616
Unzip the archive into an empty directory.
1717

18-
2. Extract the P4Ruby API archive into a new, empty directory.
18+
3. Extract the P4Ruby API archive into a new, empty directory.
1919

20-
3. Execute the build commands:
20+
4. Execute the build commands:
2121

22-
*bundle install \
23-
bundle exec rake compile -- --with-p4api_dir=<absolute path to Perforce C++ API> \
24-
           --with-ssl-dir=<absolute path to OpenSSL libraries matching Perforce C++ API>*
25-
26-
OR pass through environment variables\
27-
*bundle exec rake compile p4api_dir=<absolute path to Perforce C++ API>*
28-
29-
**Note: If the --p4api_dir flag is not provided, P4Ruby will attempt
30-
to download and extract correct version of Perforce C++ API**
22+
```
23+
bundle install
24+
bundle exec rake compile -- --with-p4api_dir=<absolute path to Perforce C++ API> --with-ssl-dir=<absolute path to OpenSSL libraries matching Perforce C++ API>
25+
```
26+
OR pass through environment variables
27+
```
28+
bundle exec rake compile p4api_dir=<absolute path to Perforce C++ API>
29+
```
30+
**Note:** If the --p4api_dir flag is not provided, P4Ruby will attempt
31+
to download and extract correct version of Perforce C++ API.
3132

32-
4. Test your distribution.
33+
5. Test your distribution.
3334

34-
*bundle exec rake test*
35+
```
36+
bundle exec rake test
37+
```
3538
3639
Tests require the perforce server binary (p4d) present in the path.
3740
38-
5. Install P4Ruby into your local gem cache:
41+
6. Install P4Ruby into your local gem cache:
3942
40-
*bundle exec rake gem*\
41-
*gem install pkg/p4ruby\*.gem -- --with-p4api_dir=<absolute path to Perforce C++ API>*
43+
```
44+
bundle exec rake gem
45+
gem install pkg/p4ruby*.gem -- --with-p4api_dir=<absolute path to Perforce C++ API>
46+
```
4247
4348
## SSL support
4449

0 commit comments

Comments
 (0)