update readme
This commit is contained in:
parent
81dcfe03af
commit
fbb06c99a1
31
README.md
31
README.md
|
@ -4,32 +4,19 @@
|
|||
|
||||
All commands above must be launched from the root of this repository.
|
||||
|
||||
In order for next steps to work properly whatever your configuration, you might execute the following command:
|
||||
### 2. Build type checkers, controllers, middlewares
|
||||
|
||||
Type checkers, controllers and middlewares have to be built before using them. A build command exists for that purpose.
|
||||
```bash
|
||||
chmod +x $GOPATH/src/git.xdrm.io/go/aicra/*.sh
|
||||
aicra [options] .
|
||||
```
|
||||
|
||||
### 2. Build type checkers
|
||||
**Options**
|
||||
- If you want the *controller* folder different than `root` define it with `-c`
|
||||
- If you want the *middleware* folder different than `middleware` define it with `-m`
|
||||
- If you want the *type checker* folder different than `types` define it with `-t`
|
||||
|
||||
Default types have to be built before using them.
|
||||
|
||||
```bash
|
||||
$GOPATH/src/git.xdrm.io/go/aicra/build-types.sh
|
||||
```
|
||||
|
||||
If the build process succeeds, the `./types` folder must contain *.so* files.
|
||||
|
||||
### 3. Build controllers
|
||||
|
||||
Controllers are located under the `./root` file structure.
|
||||
|
||||
```bash
|
||||
$GOPATH/src/git.xdrm.io/go/aicra/build-controllers.sh ./root
|
||||
```
|
||||
|
||||
If the build process succeeds, the `./controllers` folder must contain *.so* files.
|
||||
|
||||
### 4. Launch the api
|
||||
### 3. Launch the api
|
||||
|
||||
```
|
||||
$ go run ./cmd/test/main.go
|
||||
|
|
Loading…
Reference in New Issue