Skip to content

Commit 2fc5fd9

Browse files
committed
docs: move sections ton quick start guide
1 parent 8cf619c commit 2fc5fd9

File tree

1 file changed

+4
-37
lines changed

1 file changed

+4
-37
lines changed

README.md

Lines changed: 4 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ A framework for code security that provides abstractions for static analysis too
1212
- [Overview](#overview)
1313
- [Features](#features)
1414
- [SAST Tool Integration Status](#sast-tool-integration-status)
15-
- [Installation](#installation)
1615
- [Usage](#usage)
1716
- [Command-line interface](#command-line-interface)
1817
- [Python API](#python-api)
@@ -22,12 +21,14 @@ A framework for code security that provides abstractions for static analysis too
2221

2322
**CodeSecTools** is a collection of scripts and wrappers that abstract external resources (such as SAST tools, datasets, and codebases), providing standardized interfaces to help them interact easily.
2423

25-
For more details on the design and integration of SAST tools and datasets in CodeSecTools, please refer to the [documentation](https://oppida.github.io/CodeSecTools).
26-
2724
<div align="center">
2825
<img src="docs/assets/overview.svg" alt="CodeSecTools Overview" style="width: 75%; height: auto;" />
2926
</div>
3027

28+
For step-by-step instructions on installation, configuration, and basic usage, please refer to the [quick start guide](https://oppida.github.io/CodeSecTools/home/quick_start_guide.html).
29+
30+
For more details on the design and integration of SAST tools and datasets in CodeSecTools, please refer to the [documentation](https://oppida.github.io/CodeSecTools).
31+
3132
## Features
3233

3334
- **Standardized SAST Tool Integration**: Provides a common abstraction layer for integrating various SAST tools. Once a tool is integrated, it automatically benefits from the framework’s core functionalities.
@@ -52,40 +53,6 @@ For more details on the design and integration of SAST tools and datasets in Cod
5253
|SpotBugs|Java|||[Latest PR](https://github.com/OPPIDA/CodeSecTools/actions/workflows/ci.yaml)|
5354
|Cppcheck|C/C++|||[Latest PR](https://github.com/OPPIDA/CodeSecTools/actions/workflows/ci.yaml)|
5455

55-
## Installation
56-
57-
- Clone the repository:
58-
```bash
59-
git clone https://github.com/OPPIDA/CodeSecTools.git
60-
cd CodeSecTools
61-
```
62-
63-
- Install the project:
64-
65-
- Using [uv](https://github.com/astral-sh/uv):
66-
```bash
67-
uv tool install .
68-
```
69-
70-
- Using [pipx](https://github.com/pypa/pipx):
71-
```bash
72-
pipx install .
73-
```
74-
75-
- Using pip (not recommended, as it can break your system packages):
76-
```bash
77-
pip install .
78-
```
79-
80-
- Update the project:
81-
82-
- Pull the latest changes:
83-
```bash
84-
git pull
85-
```
86-
87-
- Reinstall (in case dependencies changed)
88-
8956
## Usage
9057

9158
#### Command-line interface

0 commit comments

Comments
 (0)