Add generation instructions to README
This commit is contained in:
parent
9788468c0a
commit
6465ee25bc
32
README.md
32
README.md
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
[![Go Reference](https://pkg.go.dev/badge/go.arsenm.dev/go-lemmy.svg)](https://pkg.go.dev/go.arsenm.dev/go-lemmy)
|
[![Go Reference](https://pkg.go.dev/badge/go.arsenm.dev/go-lemmy.svg)](https://pkg.go.dev/go.arsenm.dev/go-lemmy)
|
||||||
|
|
||||||
Go bindings to the [Lemmy](https://join-lemmy.org) API
|
Go bindings to the [Lemmy](https://join-lemmy.org) API, automatically generated directly from Lemmy's source code using the generator in [cmd/gen](cmd/gen).
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
|
|
||||||
@ -28,4 +28,32 @@ _, err = c.SaveUserSettings(ctx, types.SaveUserSettings{
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
panic(err)
|
panic(err)
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### How to generate
|
||||||
|
|
||||||
|
First, build the generator:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
go build ./cmd/gen
|
||||||
|
```
|
||||||
|
|
||||||
|
Clone Lemmy's source code at whatever version you need:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone https://github.com/LemmyNet/lemmy -b 0.16.7
|
||||||
|
```
|
||||||
|
|
||||||
|
Remove all the existing generated code:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
rm **/*.gen.go
|
||||||
|
```
|
||||||
|
|
||||||
|
Execute the generator:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
./gen -out-dir .
|
||||||
|
```
|
||||||
|
|
||||||
|
And that's it! Your generated code should be ready for use.
|
Loading…
Reference in New Issue
Block a user