Merge pull request #358 from JacobBarthelmeh/doc

pull/370/head
John Safranek 2021-10-26 09:26:14 -07:00 committed by GitHub
commit c0ba16f1b1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 14 additions and 6 deletions

10
README
View File

@ -2,29 +2,33 @@ WOLFSSH
=======
wolfSSL's Embeddable SSH Server
[wolfSSH Manual](https://www.wolfssl.com/docs/wolfssh-manual/)
dependencies
------------
wolfSSH is dependent on wolfCrypt. The simplest configuration of wolfSSL
required for wolfSSH is the default build.
[wolfSSH](https://www.wolfssl.com/wolfssh/) is dependent on [wolfCrypt](https://www.wolfssl.com/download/).
The simplest configuration of wolfSSL required for wolfSSH is the default build.
$ cd wolfssl
$ ./configure [OPTIONS] --enable-ssh
$ make check
$ sudo make install
On some systems the optional ldconfig command is needed after installing.
To use the key generation function in wolfSSH, wolfSSL will need to be
configured with keygen: `--enable-keygen`.
If the bulk of wolfSSL code isn't desired, wolfSSL can be configured with
the crypto only option: `--enable-cryptonly`.
Additional build options for wolfSSL are located [here](https://www.wolfssl.com/docs/wolfssl-manual/ch2/).
building
--------
From the source directory run:
From the wolfSSH source directory run:
$ ./autogen.sh
$ ./configure

View File

@ -2,29 +2,33 @@ WOLFSSH
=======
wolfSSL's Embeddable SSH Server
[wolfSSH Manual](https://www.wolfssl.com/docs/wolfssh-manual/)
dependencies
------------
wolfSSH is dependent on wolfCrypt. The simplest configuration of wolfSSL
required for wolfSSH is the default build.
[wolfSSH](https://www.wolfssl.com/wolfssh/) is dependent on [wolfCrypt](https://www.wolfssl.com/download/).
The simplest configuration of wolfSSL required for wolfSSH is the default build.
$ cd wolfssl
$ ./configure [OPTIONS] --enable-ssh
$ make check
$ sudo make install
On some systems the optional ldconfig command is needed after installing.
To use the key generation function in wolfSSH, wolfSSL will need to be
configured with keygen: `--enable-keygen`.
If the bulk of wolfSSL code isn't desired, wolfSSL can be configured with
the crypto only option: `--enable-cryptonly`.
Additional build options for wolfSSL are located [here](https://www.wolfssl.com/docs/wolfssl-manual/ch2/).
building
--------
From the source directory run:
From the wolfSSH source directory run:
$ ./autogen.sh
$ ./configure