Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,11 @@ To consume the rules defined in this repository, you need to register the custom

**Configuration Steps:**

1. **Update `.bazelrc`**: Add the following flag to your project's `.bazelrc` file to point Bazel to the raw content of the registry directory.
1. **Update `.bazelrc`**: Add the following flag to your project's `.bazelrc` file to point Bazel to the registry directory and the Bazel Central Registry.

```properties
common --registry=https://raw.githubusercontent.com/vectorgrp/bazel-rules/main/vector-bazel-central-registry
common --registry=https://bcr.bazel.build
```

2. **Add Dependencies**: In your `MODULE.bazel` file, declare the dependencies you need using `bazel_dep`.
Expand Down Expand Up @@ -68,3 +69,20 @@ This repository is structured around three main development areas:
├── docs/ # Documentation and guides
└── .github/ # CI/CD configuration
```

## Rule Documentation

Comprehensive documentation for each Bazel module is available in its respective directory:

**User Documentation**: `bcr-modules/modules/<module_name>/README.md`

### Available Modules

- **rules_cfg5** - DaVinci Configurator 5 code generation
- **rules_common** - Common utilities for DaVinci tool integration
- **rules_davinci_developer** - DaVinci Developer toolchain
- **rules_dvteam** - DaVinci Team integration automation
- **rules_gradle** - Gradle toolchain and authentication
- **rules_ocs** - OCS execution and CFG5 script tasks

Each module's README.md contains installation instructions, usage examples, API reference and troubleshooting information.
Loading
Loading