Remove some stale doc references to make

This commit is contained in:
Connor Prussin 2021-11-16 21:50:23 -08:00
parent 6e886b91ac
commit f58aa94484
No known key found for this signature in database
GPG Key ID: C72452E036D53A6A
14 changed files with 105 additions and 15 deletions

View File

@ -61,7 +61,13 @@ HTTPure ships with a number of [examples](./docs/Examples). To run an example,
in the project root, run:
```bash
make example EXAMPLE=<Example Name>
nix-shell --run 'example <Example Name>'
```
Or, without `nix`:
```bash
spago -x test.dhall run --main Examples.<Example Name>.Main
```
Each example's startup banner will include information on routes available on
@ -72,7 +78,13 @@ the example server.
To run the test suite, in the project root run:
```bash
make test
nix-shell --run check
```
Or, if `nix` isn't your thing:
```bash
purs-tidy check src test docs && spago -x test.dhall test
```
## Contributing

View File

@ -8,5 +8,11 @@ file [Hello](./Hello).
To run the example server, run:
```bash
make example EXAMPLE=AsyncResponse
nix-shell --run 'example AsyncResponse'
```
Or, without nix:
```bash
spago -x test.dhall run --main Examples.AsyncResponse.Main
```

View File

@ -6,5 +6,11 @@ binary file and send back the file's sha256 checksum.
To run the server, run:
```bash
make example EXAMPLE=BinaryRequest
nix-shell --run 'example BinaryRequest'
```
Or, without nix:
```bash
spago -x test.dhall run --main Examples.BinaryRequest.Main
```

View File

@ -6,5 +6,11 @@ file as binary data on any URL.
To run the server, run:
```bash
make example EXAMPLE=BinaryResponse
nix-shell --run 'example BinaryResponse'
```
Or, without nix:
```bash
spago -x test.dhall run --main Examples.BinaryResponse.Main
```

View File

@ -6,5 +6,11 @@ in two separate chunks spaced a second apart on any URL.
To run the example server, run:
```bash
make example EXAMPLE=Chunked
nix-shell --run 'example Chunked'
```
Or, without nix:
```bash
spago -x test.dhall run --main Examples.Chunked.Main
```

View File

@ -7,5 +7,11 @@ globally-available environment during routing.
To run the example server, run:
```bash
make example EXAMPLE=CustomStack
nix-shell --run 'example CustomStack'
```
Or, without nix:
```bash
spago -x test.dhall run --main Examples.CustomStack.Main
```

View File

@ -8,5 +8,11 @@ value 'hello world!'.
To run the example server, run:
```bash
make example EXAMPLE=Headers
nix-shell --run 'example Headers'
```
Or, without nix:
```bash
spago -x test.dhall run --main Examples.Headers.Main
```

View File

@ -6,5 +6,11 @@ making any request.
To run the example server, run:
```bash
make example EXAMPLE=HelloWorld
nix-shell --run 'example HelloWorld'
```
Or, without nix:
```bash
spago -x test.dhall run --main Examples.HelloWorld.Main
```

View File

@ -9,5 +9,11 @@ the response, and one that handles requests to a given path.
To run the example server, run:
```bash
make example EXAMPLE=Middleware
nix-shell --run 'example Middleware'
```
Or, without nix:
```bash
spago -x test.dhall run --main Examples.Middleware.Main
```

View File

@ -7,5 +7,11 @@ return 'hello' when requesting /hello with an HTTP GET, and it will return
To run the example server, run:
```bash
make example EXAMPLE=MultiRoute
nix-shell --run 'example MultiRoute'
```
Or, without nix:
```bash
spago -x test.dhall run --main Examples.MultiRoute.Main
```

View File

@ -7,5 +7,11 @@ that routes based on the value of specific segments.
To run the example server, run:
```bash
make example EXAMPLE=PathSegments
nix-shell --run 'example PathSegments'
```
Or, without nix:
```bash
spago -x test.dhall run --main Examples.PathSegments.Main
```

View File

@ -6,5 +6,11 @@ any path with the post body in the response body.
To run the example server, run:
```bash
make example EXAMPLE=Post
nix-shell --run 'example Post'
```
Or, without nix:
```bash
spago -x test.dhall run --main Examples.Post.Main
```

View File

@ -8,5 +8,11 @@ example where the response is driven by the contents of a query parameter.
To run the example server, run:
```bash
make example EXAMPLE=QueryParameters
nix-shell --run 'example QueryParameters'
```
Or, without nix:
```bash
spago -x test.dhall run --main Examples.QueryParameters.Main
```

View File

@ -9,5 +9,11 @@ certificate errors when testing.
To run the example server, run:
```bash
make example EXAMPLE=SSL
nix-shell --run 'example SSL'
```
Or, without nix:
```bash
spago -x test.dhall run --main Examples.SSL.Main
```