diff --git a/README b/README index fa04ff15..6986ad18 100644 --- a/README +++ b/README @@ -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 @@ -232,6 +236,7 @@ An example of connecting to another system would be shell support in example echoserver ----------------------------------- + wolfSSH's example echoserver can now fork a shell for the user trying to log in. This currently has only been tested on Linux and macOS. The file echoserver.c must be modified to have the user's credentials in the user diff --git a/README.md b/README.md index fa04ff15..6986ad18 100644 --- a/README.md +++ b/README.md @@ -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 @@ -232,6 +236,7 @@ An example of connecting to another system would be shell support in example echoserver ----------------------------------- + wolfSSH's example echoserver can now fork a shell for the user trying to log in. This currently has only been tested on Linux and macOS. The file echoserver.c must be modified to have the user's credentials in the user