Skip to content

Commit

Permalink
Update README with new installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
lennartmoeller committed Apr 2, 2023
1 parent 8fe1f46 commit 7e07ccb
Showing 1 changed file with 12 additions and 13 deletions.
25 changes: 12 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ GitLocHistory uses `scc` (https://github.com/boyter/scc), a gold standard for ca

## Terminology

There are different understandings of which abbreviation means what. Here the abbreviations are used as follows:
There are different understandings of which abbreviation means what. In this project the abbreviations are used as follows:

- **LOC**: Total lines of code (SLOC + CLOC + ELOC)
- **LLOC**: Lines of logical code (SLOC + CLOC)
Expand All @@ -30,32 +30,31 @@ Before you can use GitLocHistory, you need to have the following tools installed

## Installation & Usage

1. Clone the GitLocHistory repository to your local machine.
```shell
git clone git:github.com/lennartmoeller/GitLocHistory.git
```
1. [Download the latest release](https://github.com/lennartmoeller/GitLocHistory/releases/latest/download/glh.zip) and extract the zip file.

2. Open a terminal and navigate to the extracted directory.

2. Install the required Python packages.
3. Install the required Python packages:
```shell
pip3 install -r GitLocHistory/requirements.txt
pip3 install -r requirements.txt
```

3. Modify the file named `config.json`. See the Configuration section for more details.
4. Modify the file named `config.json`. See the Configuration section for more details.

4. Run GitLocHistory.
5. Run GitLocHistory:
```shell
python3 GitLocHistory/glh.py
python3 glh.py
```

5. Open the `viewer.html` file in your browser to view the result diagram.
6. Open the `viewer.html` file in your browser to view the result diagram.

6. The output is saved in the output JSON file in the `GitLocHistory` directory.
7. The output is saved in the output JSON file.



## Configuration

GitLocHistory uses a configuration file named `config.json` inside the `GitLocHistory` directory.
GitLocHistory uses a configuration file named `config.json`.

Here's an example `config.json` file:

Expand Down

0 comments on commit 7e07ccb

Please sign in to comment.