Skip to content

Commit

Permalink
doc: Add usage example in README
Browse files Browse the repository at this point in the history
  • Loading branch information
A. Challande committed May 31, 2021
1 parent dfcbc16 commit dcfea7d
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,19 @@ BGraph
`BGraph` is a tool designed to generate dependencies graphs from `Android.bp` soong files.

## Overview
`BGraph` (for `Build-Graphs`) is a project aimed at create build graphs from _blueprints_ in AOSP and querying those graphs.

The tool is divided in two independents parts :
In short, this project builds/uses Unified Dependency Graph for the [Android Open Source Project](https://source.android.com/) by parsing and linking modules
defined in the Android build system [Soong](https://source.android.com/setup/build).

### Use-cases

You should use this tool if you want to find:

* all the dependencies of a source file in AOSP;
* all the sources involved in the building of a target in AOSP;
* common dependencies between two targets.

* a BGraph generator to generate BGraphs from AOSP versions
* a BGraph tool to query the generated graphs

## Usage
```bash
Expand Down Expand Up @@ -48,7 +56,7 @@ Commands:
poetry install bgraph
```
### Using pip (not available yet)
### Using pip
```bash
pip install bgraph
```
Expand Down

0 comments on commit dcfea7d

Please sign in to comment.