Skip to content

Commit

Permalink
Add installation steps
Browse files Browse the repository at this point in the history
  • Loading branch information
samriddhi99 authored and Akshat0694 committed Jul 17, 2024
1 parent bacf204 commit c21201c
Showing 1 changed file with 42 additions and 0 deletions.
42 changes: 42 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ Tirith scans declarative Infrastructure as Code (IaC) configurations like Terraf
<!-- - [Local Development Environment](#local-development-environment) -->
- [What is Tirith?](#what-is-tirith)
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Example Tirith policies](#example-tirith-policies)
- [Terraform Plan](#terraform-plan-provider)
Expand Down Expand Up @@ -66,6 +67,47 @@ This is only a list of approved features that will be included in Tirith over th
- Support for Cloudformation and ARM
- Extended library of evaluator functions -->

## Installation

### Setup Tirith on your system (developer install)
Here we are going to install Tirith in a Python virtual environment.

1. Clone the Tirith repository to your system
```
git clone https://github.com/StackGuardian/tirith.git
```

2. Change directory to the cloned repository
```
cd tirith
```

3. Setup a virtualenv
```
virtualenv .venv
```

4. Activate the virtualenv
```
source .venv/bin/activate
```

5. Install Tirith in the virtualenv
```
# The -e is optional, just in case you wanna make some changes to the codebase
pip install -e .
```

6. Verify that Tirith is installed

```
tirith --version
1.0.0-beta.12
```

Congratulations! Tirith has been setup in your system

## Usage

```
Expand Down

0 comments on commit c21201c

Please sign in to comment.