Skip to content

Commit dc798d6

Browse files
committed
Update readme
1 parent 29339d2 commit dc798d6

File tree

1 file changed

+16
-7
lines changed

1 file changed

+16
-7
lines changed

README.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
11
# AI Act Implementation Tool
22

3-
Open-source template for 1) AI system definition check and 2) high-risk classification. Based on AI Act requirements and soft law frameworks, such as the Research framework Algorithms of the Netherlands Executive Audit Agency, the Algorithm framework of the Dutch Ministry of the Interior and the Dutch Fundamental Rights Impact Assessment (IAMA).
4-
5-
The templates are available in JSON format and can be easily customized to fit the specific needs of an organization.
3+
Opinionated implementation of [AI act questions](https://github.com/NGO-Algorithm-Audit/AI-Act-Questions) created by the Algorithm Audit team.
64

75
# How to run
86

9-
Follow these steps to set up and run the application on your local machine.
7+
This project includes a Git submodule that references the JSON Schemas repository (LINK), allowing us to keep schema definitions separate while using them within this project. Follow these steps to setup everything correctly.
108

119
## Prerequisites
10+
1211
Ensure the following are installed on your system:
1312

1413
Node.js (version 14 or later)
@@ -20,14 +19,24 @@ node -v
2019
npm -v
2120
```
2221

23-
First, clone the repository to your local machine. Open your terminal and run:
22+
##### 1. Clone the repository to your local machine. Open your terminal and run:
2423

2524
```bash
2625
git clone https://github.com/your-username/your-repo-name.git
2726
cd your-repo-name
2827
```
2928

30-
Once inside the project directory, install the necessary packages by running:
29+
##### 2. JSON Schemas Submodule
30+
31+
```bash
32+
# If you’re cloning this repository for the first time, or if you haven't initialized the submodule yet
33+
git submodule update --init --recursive
34+
35+
# To update the submodule
36+
git submodule update --remote --merge
37+
```
38+
39+
##### 3. Once inside the project directory, install the necessary packages by running:
3140

3241
```bash
3342
# If you use npm
@@ -37,7 +46,7 @@ npm install
3746
yarn install
3847
```
3948

40-
After the dependencies are installed, start the development server with:
49+
##### 4. After the dependencies are installed, start the development server with:
4150

4251
```bash
4352
# If using npm

0 commit comments

Comments
 (0)