Update docs. Better error message when openssl fails. Simplifying
`KubernetesClientConfiguration`
This commit is contained in:
31
README.md
31
README.md
@@ -1,43 +1,58 @@
|
||||
# csharp
|
||||
Work In Progress
|
||||
Currently only supported on Linux
|
||||
|
||||
[](https://travis-ci.org/kubernetes-client/csharp)
|
||||
|
||||
# Generating the client code
|
||||
# Generating the Client Code
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Check out the generator project into some other directory
|
||||
(henceforth `$GEN_DIR`)
|
||||
|
||||
```
|
||||
```bash
|
||||
cd $GEN_DIR/..
|
||||
git clone https://github.com/kubernetes-client/gen
|
||||
```
|
||||
|
||||
Install the [`autorest` tool](https://github.com/azure/autorest):
|
||||
|
||||
```
|
||||
```bash
|
||||
npm install autorest
|
||||
```
|
||||
|
||||
## Generating code
|
||||
|
||||
```
|
||||
```bash
|
||||
# Where REPO_DIR points to the root of the csharp repository
|
||||
cd ${REPO_DIR}/csharp/src
|
||||
${GEN_DIR}/openapi/csharp.sh generated csharp.settings
|
||||
```
|
||||
|
||||
# Testing
|
||||
# Usage
|
||||
|
||||
## Prerequisities
|
||||
|
||||
* [OpenSSL](https://www.openssl.org/)
|
||||
* For Linux/Mac:
|
||||
* LibCurl built with OpenSSL (Mac: `brew install curl --with-nghttp2`)
|
||||
|
||||
## Running the Examples
|
||||
|
||||
```bash
|
||||
git clone git@github.com:kubernetes-client/csharp.git
|
||||
cd csharp\examples\simple
|
||||
dotnet run
|
||||
```
|
||||
|
||||
## Testing
|
||||
|
||||
The project uses [XUnit](https://xunit.github.io) as unit testing framework.
|
||||
|
||||
To run the tests you need to:
|
||||
To run the tests
|
||||
|
||||
```bash
|
||||
cd tests
|
||||
cd csharp\tests
|
||||
dotnet restore
|
||||
dotnet xunit
|
||||
```
|
||||
Reference in New Issue
Block a user