Skip to content

Commit

Permalink
Add LICENSE
Browse files Browse the repository at this point in the history
  • Loading branch information
w-gao committed Jan 16, 2023
1 parent 95d6947 commit ff86158
Show file tree
Hide file tree
Showing 2 changed files with 56 additions and 23 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2022-2023 William Gao

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
58 changes: 35 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,29 +9,6 @@ A Workflow Description Language (WDL) parser in Go.
[wdl-viewer](https://github.com/w-gao/wdl-viewer)


## Getting started

### Install from source

To install `gowdl` from source, first clone this repo:

```
https://github.com/w-gao/gowdl.git
```

Then, generate the necessary parsers:

```
make generate
```

Finally, install the local package:

```
go install .
```


## API

`gowdl` provides a few APIs that can be used in your own project.
Expand Down Expand Up @@ -145,3 +122,38 @@ Sample output:
}
]
```


## Getting started

If you want to contribute to the project or try it out locally, you can install
`gowdl` in the following ways:

### Install from source

To install `gowdl` from source, first clone this repo:

```
https://github.com/w-gao/gowdl.git
```

Then, generate the necessary parsers:

```
make generate
```

Finally, install the local package:

```
go install .
```

### Add as dependency via `go get`

This is not available yet.


## LICENSE

MIT License. Copyright (c) 2022-2023 William Gao

0 comments on commit ff86158

Please sign in to comment.