Skip to content

Commit 4748b7a

Browse files
agateau-ggpierrelalanne
authored andcommitted
doc: update installation instructions
1 parent bc10119 commit 4748b7a

File tree

1 file changed

+36
-16
lines changed

1 file changed

+36
-16
lines changed

README.md

Lines changed: 36 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,18 @@
11
# src-fingerprint
22

3-
- [src-fingerprint](#src-fingerprint)
4-
- [Introduction](#introduction)
5-
- [Install](#install)
6-
- [Generate My Token](#generate-my-token)
3+
- [Introduction](#introduction)
4+
- [Installation](#installation)
5+
- [Using pre-compiled executables](#using-pre-compiled-executables)
6+
- [Installing from sources](#installing-from-sources)
7+
- [Generate My Token](#generate-my-token)
78
- [GitHub](#github)
89
- [GitLab](#gitlab)
9-
- [Compute my code fingerprints](#compute-my-code-fingerprints)
10+
- [Compute my code fingerprints](#compute-my-code-fingerprints)
1011
- [GitHub](#github-1)
1112
- [GitLab](#gitlab-1)
1213
- [Bitbucket server (formely Atlassian Stash)](#bitbucket-server-formely-atlassian-stash)
1314
- [Repository](#repository)
14-
- [License](#License)
15+
- [License](#License)
1516

1617
## Introduction
1718

@@ -23,22 +24,20 @@ This util supports 3 main version control systems:
2324
- Gitlab CE and EE
2425
- Bitbucket
2526

26-
## Install
27+
## Installation
2728

28-
### Pre-compiled executables
29+
### Using pre-compiled executables
2930

30-
Get the executables [here](http://github.com/gitguardian/src-fingerprint/releases).
31+
#### macOS, using Homebrew
3132

32-
### Using Homebrew
33-
34-
If you're using [Homebrew](https://brew.sh/index_fr) you can add GitGuardian's tap and then install src-fingerprint. Just run the following commands :
33+
If you're using [Homebrew](https://brew.sh/index) you can add GitGuardian's tap and then install src-fingerprint. Just run the following commands:
3534

3635
```shell
3736
brew tap gitguardian/tap
3837
brew install src-fingerprint
3938
```
4039

41-
### Linux packages
40+
#### Linux packages
4241

4342
Deb and RPM packages are available on [Cloudsmith](https://cloudsmith.io/~gitguardian/repos/src-fingerprint/packages/).
4443

@@ -47,10 +46,31 @@ Setup instructions:
4746
- [Deb packages](https://cloudsmith.io/~gitguardian/repos/src-fingerprint/setup/#formats-deb)
4847
- [RPM packages](https://cloudsmith.io/~gitguardian/repos/src-fingerprint/setup/#formats-rpm)
4948

50-
### From the sources
49+
#### Windows
50+
51+
Open a PowerShell prompt and run this command:
52+
53+
```shell
54+
iwr -useb https://raw.githubusercontent.com/GitGuardian/src-fingerprint/main/scripts/windows-installer.ps1 | iex
55+
```
56+
57+
The script asks for the installation directory. To install silently, use these commands instead:
58+
59+
```shell
60+
iwr -useb https://raw.githubusercontent.com/GitGuardian/src-fingerprint/main/scripts/windows-installer.ps1 -Outfile install.ps1
61+
.\install.ps1 C:\Destination\Dir
62+
rm install.ps1
63+
```
64+
65+
Note that `src-fingerprint` requires Unix commands such as `bash` to be available, so it runs better from a "Git Bash" prompt.
66+
67+
#### Manual download
68+
69+
You can also download the archives directly from the [releases page](http://github.com/gitguardian/src-fingerprint/releases).
70+
71+
### Installing from sources
5172

52-
You need `go` installed and `GOBIN` in your `PATH`. Once that is done, run the
53-
command:
73+
You need `go` installed and `GOBIN` in your `PATH`. Once that is done, run the command:
5474

5575
```shell
5676
$ go get -u github.com/gitguardian/src-fingerprint/cmd/src-fingerprint

0 commit comments

Comments
 (0)