Skip to content

Commit c0ba16f

Browse files
authored
Merge pull request #358 from JacobBarthelmeh/doc
2 parents ddd15cb + c981e52 commit c0ba16f

2 files changed

Lines changed: 14 additions & 6 deletions

File tree

README

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,29 +2,33 @@ WOLFSSH
22
=======
33

44
wolfSSL's Embeddable SSH Server
5+
[wolfSSH Manual](https://www.wolfssl.com/docs/wolfssh-manual/)
56

67
dependencies
78
------------
89

9-
wolfSSH is dependent on wolfCrypt. The simplest configuration of wolfSSL
10-
required for wolfSSH is the default build.
10+
[wolfSSH](https://www.wolfssl.com/wolfssh/) is dependent on [wolfCrypt](https://www.wolfssl.com/download/).
11+
The simplest configuration of wolfSSL required for wolfSSH is the default build.
1112

1213
$ cd wolfssl
1314
$ ./configure [OPTIONS] --enable-ssh
1415
$ make check
1516
$ sudo make install
1617

18+
On some systems the optional ldconfig command is needed after installing.
19+
1720
To use the key generation function in wolfSSH, wolfSSL will need to be
1821
configured with keygen: `--enable-keygen`.
1922

2023
If the bulk of wolfSSL code isn't desired, wolfSSL can be configured with
2124
the crypto only option: `--enable-cryptonly`.
2225

26+
Additional build options for wolfSSL are located [here](https://www.wolfssl.com/docs/wolfssl-manual/ch2/).
2327

2428
building
2529
--------
2630

27-
From the source directory run:
31+
From the wolfSSH source directory run:
2832

2933
$ ./autogen.sh
3034
$ ./configure

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,29 +2,33 @@ WOLFSSH
22
=======
33

44
wolfSSL's Embeddable SSH Server
5+
[wolfSSH Manual](https://www.wolfssl.com/docs/wolfssh-manual/)
56

67
dependencies
78
------------
89

9-
wolfSSH is dependent on wolfCrypt. The simplest configuration of wolfSSL
10-
required for wolfSSH is the default build.
10+
[wolfSSH](https://www.wolfssl.com/wolfssh/) is dependent on [wolfCrypt](https://www.wolfssl.com/download/).
11+
The simplest configuration of wolfSSL required for wolfSSH is the default build.
1112

1213
$ cd wolfssl
1314
$ ./configure [OPTIONS] --enable-ssh
1415
$ make check
1516
$ sudo make install
1617

18+
On some systems the optional ldconfig command is needed after installing.
19+
1720
To use the key generation function in wolfSSH, wolfSSL will need to be
1821
configured with keygen: `--enable-keygen`.
1922

2023
If the bulk of wolfSSL code isn't desired, wolfSSL can be configured with
2124
the crypto only option: `--enable-cryptonly`.
2225

26+
Additional build options for wolfSSL are located [here](https://www.wolfssl.com/docs/wolfssl-manual/ch2/).
2327

2428
building
2529
--------
2630

27-
From the source directory run:
31+
From the wolfSSH source directory run:
2832

2933
$ ./autogen.sh
3034
$ ./configure

0 commit comments

Comments
 (0)