Mirrors/libwebsockets
1
0
Fork 0
mirror of https://github.com/warmcat/libwebsockets.git synced 2025-03-09 00:00:04 +01:00
Code Issues Releases Wiki Activity

docs: fixup links broken by move to READMEs

Browse source
This commit is contained in:
Andy Green 2017-11-26 18:51:01 +08:00
parent b1934d6b64
commit 4ff8e866d5
3 changed files with 11 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
READMEs/README.build.md
View file

@ -25,7 +25,7 @@ with SSL support (for OpenSSL/wolfSSL/BoringSSL):
@section build1 Building the library and test apps
The project settings used by CMake to generate the platform specific build
files is called [CMakeLists.txt](CMakeLists.txt). CMake then uses one of its "Generators" to
files is called [CMakeLists.txt](../CMakeLists.txt). CMake then uses one of its "Generators" to
output a Visual Studio project or Make file for instance. To see a list of
the available generators for your platform, simply run the "cmake" command.
@ -54,7 +54,7 @@ see below on how to toggle compile options.
```
**NOTE**: The `build/`` directory can have any name and be located anywhere
on your filesystem, and that the argument `..` given to cmake is simply
the source directory of **libwebsockets** containing the [CMakeLists.txt](CMakeLists.txt)
the source directory of **libwebsockets** containing the [CMakeLists.txt](../CMakeLists.txt)
project file. All examples in this file assumes you use ".."
**NOTE2**:
@ -235,7 +235,7 @@ deleting build/CMakeCache.txt may be enough.
```
(**NOTE**: The `build/`` directory can have any name and be located anywhere
on your filesystem, and that the argument `..` given to cmake is simply
the source directory of **libwebsockets** containing the [CMakeLists.txt](CMakeLists.txt)
the source directory of **libwebsockets** containing the [CMakeLists.txt](../CMakeLists.txt)
project file. All examples in this file assumes you use "..")
**NOTE2**:
@ -447,7 +447,7 @@ a "Toolchain file" that you supply to CMake when generating your build files.
CMake will then use the cross compilers and build paths specified in this file
to look for dependencies and such.
**Libwebsockets** includes an example toolchain file [cross-arm-linux-gnueabihf.cmake](cross-arm-linux-gnueabihf.cmake)
**Libwebsockets** includes an example toolchain file [cross-arm-linux-gnueabihf.cmake](../contrib/cross-arm-linux-gnueabihf.cmake)
you can use as a starting point.
The commandline to configure for cross with this would look like

2
READMEs/README.coding.md
View file

@ -500,7 +500,7 @@ other reasons, if any of that happens you'll get a
After attempting the connection and getting back a non-`NULL` `wsi` you should
loop calling `lws_service()` until one of the above callbacks occurs.
As usual, see [test-client.c](test-apps/test-client.c) for example code.
As usual, see [test-client.c](../test-apps/test-client.c) for example code.
Notice that the client connection api tries to progress the connection
somewhat before returning. That means it's possible to get callbacks like

12
READMEs/README.test-apps.md
View file

@ -2,7 +2,7 @@ Overview of lws test apps
=========================
Are you building a client? You just need to look at the test client
[libwebsockets-test-client](test-apps/test-client.c).
[libwebsockets-test-client](../test-apps/test-client.c).
If you are building a standalone server, there are three choices, in order of
preferability.
@ -13,12 +13,12 @@ Lws provides a generic web server app that can be configured with JSON
config files. https://libwebsockets.org itself uses this method.
With lwsws handling the serving part, you only need to write an lws protocol
plugin. See [plugin-standalone](plugin-standalone) for an example of how
plugin. See [plugin-standalone](../plugin-standalone) for an example of how
to do that outside lws itself, using lws public apis.
$ cmake .. -DLWS_WITH_LWSWS=1
See [README.lwsws.md](READMEs/README.lwsws.md) for information on how to configure
See [README.lwsws.md](../READMEs/README.lwsws.md) for information on how to configure
lwsws.
NOTE this method implies libuv is used by lws, to provide crossplatform
@ -32,7 +32,7 @@ Plugins are still used, which implies libuv needed.
$ cmake .. -DLWS_WITH_PLUGINS=1
See [test-server-v2.0.c](test-apps/test-server-v2.0.c)
See [test-server-v2.0.c](../test-apps/test-server-v2.0.c)
3) protocols in the server app
@ -49,7 +49,7 @@ Notes about lws test apps
@section tsb Testing server with a browser
If you run [libwebsockets-test-server](test-apps/test-server.c) and point your browser
If you run [libwebsockets-test-server](../test-apps/test-server.c) and point your browser
(eg, Chrome) to
http://127.0.0.1:7681
@ -154,7 +154,7 @@ certificates in the browser and the connection will proceed
in first https and then websocket wss, acting exactly the
same.
[test-server.c](test-apps/test-server.c) is all that is needed to use libwebsockets for
[test-server.c](../test-apps/test-server.c) is all that is needed to use libwebsockets for
serving both the script html over http and websockets.
@section lwstsdynvhost Dynamic Vhosts