From: Ben Beltran Date: Fri, 28 Dec 2018 19:53:37 +0000 (-0700) Subject: Update README with build guide X-Git-Tag: 1.0.0^2~1^2~2 X-Git-Url: https://git.r.bdr.sh/rbdr/ngx_http_office_hours_filter_module/commitdiff_plain/e7564a5bef309184c039a12e4c60c676b2590c0d?hp=348cd2c979f79ce5a425937879591933f18750fc Update README with build guide --- diff --git a/README.md b/README.md index 50211c1..658e64f 100644 --- a/README.md +++ b/README.md @@ -58,15 +58,13 @@ Uninstall nginx. ## What you will need to get started -I'm still not sure! I'm learning how to build this nginx module, so I'll -figure it out as I go and add it here. - * [astyle][astyle]: Used to format the code * An `nginx` [source distribution][nginx] to compile the code. +* A way to compile `nginx`. Check out [their guide][nginx-guide]! ## Building the module -You can build this module as a dynamic module. From the `nginx` source +You can build office hours as a dynamic module. From the `nginx` source directory run: ``` @@ -91,4 +89,5 @@ commit. Run `make setup_hooks` to install it. [astyle]: http://astyle.sourceforge.net [nginx]: https://nginx.org/en/download.html +[nginx-guide]: https://docs.nginx.com/nginx/admin-guide/installing-nginx/installing-nginx-open-source/#sources [nginx-module-docs]: https://www.nginx.com/resources/wiki/extending/