Skip to content

Commit

Permalink
Readme Updates For Depends
Browse files Browse the repository at this point in the history
- more details on getting started
- Added License to readme
- Added Screenshot of tool
- Added Logo(s)
  • Loading branch information
khalidabuhakmeh committed Oct 1, 2020
1 parent f7d8c3a commit a45736c
Show file tree
Hide file tree
Showing 5 changed files with 75 additions and 7 deletions.
5 changes: 4 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -330,4 +330,7 @@ ASALocalRun/
.mfractor/

.vscode
.ionide
.ionide

#macOS
.DS_Store
77 changes: 71 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,75 @@
# depends
Dependency explorer for .NET
# Depends

# installation
```
![depends logo](./media/Full%[email protected])

**Depends** is a [dotnet](https://dot.net) global tool that helps developers explore dependencies found in a .NET Core project (`.csrpoj`) or solution (`.sln`).

![screenshot of depends running in terminal](./media/screenshot.png)

## Getting Started

Developers have the option of installing the .NET tool globally or locally. **We recommend installing it globally using the following command line input.**

### Global Installation

To use Depends system-wide, we can install the tool globally with the following command.

```console
dotnet tool install --global dotnet-depends
```

# limitations
* Currently only works with the new csproj format. See [issue #3](https://github.com/mholo65/depends/issues/3)
Once installed, developers can analyze any project from a terminal instance.

```console
dotnet-depends ./depends.sln
```

### Local Installation

To install the tool locally, we can run the following commands. **Note, installing local tools only works with .NET Core 3.0 SDK and later**.

In our solution folder, we need to add a new tool manifest.

```console
dotnet new tool-manifest
```

We can then install **Depends** using the following command.

```console
dotnet tool install dotnet-depends
```

To run the tool within a current solution, we need to run the following command.

```console
dotnet dotnet-depends ./our-solution.sln
```

## Troubleshooting

[Please refer to the official Microsoft Documentation around .NET tools to resolve any issues.](https://docs.microsoft.com/en-us/dotnet/core/tools/troubleshoot-usage-issues)

## License

MIT License

Copyright (c) 2018 Martin Björkström

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.
Binary file added media/Full [email protected]
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/[email protected]
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a45736c

Please sign in to comment.