Skip to content

Commit

Permalink
Update get started instructions
Browse files Browse the repository at this point in the history
Signed-off-by: Aditya Sirish <[email protected]>
  • Loading branch information
adityasaky committed Jan 17, 2024
1 parent b020403 commit 9411f69
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 95 deletions.
3 changes: 3 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ nav_external_links:
- title: Demo
url: https://github.com/gittuf/demo
hide_icon: false
- title: Installation & Get Started
url: https://github.com/gittuf/gittuf/blob/main/docs/get-started.md
hide_icon: false
- title: Roadmap
url: https://github.com/gittuf/gittuf/blob/main/docs/roadmap.md
hide_icon: false
77 changes: 0 additions & 77 deletions guide.md

This file was deleted.

21 changes: 3 additions & 18 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,28 +21,13 @@ as part of the [Supply Chain Integrity Working Group].
gittuf is currently in alpha. Please do not use it in a production system or
repository.

## Installation
## Installation & Get Started

The [gittuf repository] provides pre-built binaries that are signed and
published using [GoReleaser]. The signature for these binaries are generated
using [Sigstore], using the release workflow's identity. Please use release
v0.1.0 or higher, as prior releases were created to test the release workflow.
Alternatively, gittuf can also be installed using `go install`.

To build from source, clone the repository and run `make`. This will also run
the test suite prior to installing gittuf. Note that Go 1.21 or higher is
necessary to build gittuf.

```bash
$ git clone https://github.com/gittuf/gittuf
$ cd gittuf
$ make
```
See the [get started guide] in the [gittuf repository].

[The Update Framework (TUF)]: https://theupdateframework.io
[other attacks]: https://ssl.engineering.nyu.edu/papers/torres_toto_usenixsec-2016.pdf
[Open Source Security Foundation (OpenSSF)]: https://openssf.org/
[Supply Chain Integrity Working Group]: https://github.com/ossf/wg-supply-chain-integrity
[gittuf repository]: https://github.com/gittuf/gittuf
[GoReleaser]: https://goreleaser.com/
[Sigstore]: https://www.sigstore.dev/
[get started guide]: https://github.com/gittuf/gittuf/blob/main/docs/get-started.md

0 comments on commit 9411f69

Please sign in to comment.