Skip to content

Commit

Permalink
Add license add friendlier README
Browse files Browse the repository at this point in the history
  • Loading branch information
egonelbre committed Dec 27, 2018
1 parent 7a28f05 commit 6aa7b52
Show file tree
Hide file tree
Showing 2 changed files with 58 additions and 13 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2018 Egon Elbre <egonelbre@gmail.com>

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.
50 changes: 37 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,8 @@
# goda

Goda is a Go dependency analysing toolset.
Goda is a Go dependency analysis toolkit. It contains a bunch of different things to figure out what your program is using.

```
Usage: goda <flags> <subcommand> <subcommand args>
Subcommands:
cut Print dependencies cutting information.
exec Run command with extended statistics.
expr Help about package expressions
graph Print dependency graph.
list List packages
nm Analyse binary symbols.
tree Print dependency tree.
```
_Note: the exact syntax of the command line arguments has not yet been finalized. So expect some changes to it._

Cool things it can do:

Expand All @@ -39,3 +28,38 @@ goda tree ./...
# print stats while building a go program
go build -a --toolexec "goda exec" .
```

Maybe you noticed that it's using some weird symbols on the command-line while specifying packages. They allow to specify more complex scenarios.

The basic syntax is that you can specify multiple packages:

```
goda list github.com/loov/goda/... github.com/loov/qloc
```

By default it will select all the pacakges and dependencies of those packages. You can select only the packages with `$` and only the dependencies with `@`. For example:

```
goda list github.com/loov/goda/... @
goda list github.com/loov/goda/... $
```

You can also do basic arithmetic with these sets. For example, if you wish to ignore all `golang.org/x/tools` things in your output you can write:

```
goda list github.com/loov/goda/... - golang.org/x/tools/...
```

There's also `+` which allows to list the shared dependencies:

```
goda list github.com/loov/goda/exec + github.com/loov/goda/graph
```

All of these can of course be combined:

```
# list packages used by github.com/loov/goda
# excluding golang.org/x/tools/..., but not their dependencies
goda list github.com/loov/goda/... @ - golang.org/x/tools/... $
```

0 comments on commit 6aa7b52

Please sign in to comment.