Skip to content

Commit e57c82d

Browse files
committed
feat(doc): add enablement.md file
1 parent 224f002 commit e57c82d

File tree

1 file changed

+115
-0
lines changed

1 file changed

+115
-0
lines changed

ENABLEMENT.md

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
# Enablement Guide for Impact Framework (IF)
2+
3+
## What is the Impact Framework?
4+
5+
The **Impact Framework (IF)** empowers you to calculate and understand the environmental impact of your software. It comes with a standard library of built-in plugins, referred to as builtins, and an Explorer for discovering and installing third-party plugins.
6+
7+
## How to Use the Impact Framework?
8+
9+
### Prerequisites
10+
11+
Before getting started, ensure you have the following:
12+
13+
1. **Node.js**: Installed and configured.
14+
2. **NPM**: Comes with Node.js; ensure it’s updated.
15+
3. **Access to Documentation**: Familiarize yourself with the [IF documentation](https://if.greensoftware.foundation/).
16+
4. **Basic YAML Knowledge**: For creating and managing manifest files.
17+
18+
## Steps to Enable the Impact Framework
19+
20+
### Step 1: Installation
21+
22+
Install the latest version of IF globally using NPM:
23+
24+
```sh
25+
npm install -g "@grnsft/if"
26+
```
27+
28+
`IF` provides multiple command-line tools, with the primary tool being `if-run`.
29+
30+
### Step 2: Working with Command-Line Tools
31+
32+
1. `if-run`: Execute Manifest Files
33+
34+
- Description: Executes manifest files to calculate impact.
35+
- Manifest File: A YAML file central to IF functionality. It contains configurations, application architecture, input data, and serves as a portable, shareable, human-readable document for audits.
36+
- Usage:
37+
38+
```sh
39+
if-run --manifest <path-to-your-manifest-file>
40+
```
41+
42+
More about if-run [here](https://if.greensoftware.foundation/reference/cli#if-run).
43+
44+
2. `if-env`: Create Local Development Environments
45+
46+
- Description: Sets up a local environment for running manifests.
47+
- Usage:
48+
49+
```sh
50+
mkdir my-manifest && cd my-manifest
51+
if-env
52+
```
53+
54+
Find details in the [documentation](https://if.greensoftware.foundation/reference/cli#if-env).
55+
56+
3. `if-check`: Verify Manifests
57+
58+
- Description: Combines the functionalities of if-env and if-diff to verify manifest files with outputs and execution sections.
59+
- Usage:
60+
61+
```sh
62+
# Check a specific manifest file
63+
if-check -m <path-to-your-manifest-file>
64+
65+
# Check all manifests in a directory
66+
if-check -d /path-to-your-manifests
67+
```
68+
69+
Explore more in the [documentation](https://if.greensoftware.foundation/reference/cli#if-check).
70+
71+
4. `if-csv`: Save Data to CSV
72+
73+
- Description: Saves calculated impact data to a CSV file.
74+
- Usage:
75+
76+
```sh
77+
if-csv -m ./my-manifest.yml -p carbon
78+
```
79+
80+
Read more in the [documentation](https://if.greensoftware.foundation/reference/cli#if-csv).
81+
82+
5. `if-diff`: Compare Manifests or Outputs
83+
84+
- Description: Compares two manifest or output files to identify differences.
85+
- Usage:
86+
87+
```sh
88+
if-diff <file1> <file2>
89+
```
90+
91+
Details are available in the [documentation](https://if.greensoftware.foundation/reference/cli#if-diff).
92+
93+
### Step 3: Explore Plugins
94+
95+
- Built-In Plugins: Utilize IF’s built-ins for common environmental impact assessments.
96+
- Third-Party Plugins: Visit the Explorer to discover and install third-party plugins tailored to your needs.
97+
98+
### Step 4: Help and Guidance
99+
100+
For assistance with any command, use the --help flag:
101+
102+
```sh
103+
if-run --help
104+
```
105+
106+
## Additional Resources
107+
108+
- Documentation: [IF Documentation](https://if.greensoftware.foundation)
109+
- Third-Party Plugins: [Plugin Explorer](https://explorer.if.greensoftware.foundation)
110+
111+
## Support
112+
113+
Join the IF Community for updates and discussions:
114+
115+
- Mailing List: [if-community@greensoftware.foundation](https://groups.google.com/u/1/a/greensoftware.foundation/g/if-community)

0 commit comments

Comments
 (0)