Update README, legal stuff, make license clear, add contributors.
This commit is contained in:
parent
a8d5d956ed
commit
a95804e830
6
CONTRIBUTORS
Normal file
6
CONTRIBUTORS
Normal file
@ -0,0 +1,6 @@
|
||||
The Hockeypuck Contributors are:
|
||||
|
||||
Casey Marshall <git@cmars.tech>
|
||||
Joel Sing <joel.sing@canonical.com>
|
||||
Paul Collins <paul.collins@canonical.com>
|
||||
Simon Law <slaw@quantcast.com>
|
31
README.md
31
README.md
@ -2,14 +2,28 @@
|
||||
|
||||
Hockeypuck is an OpenPGP public keyserver.
|
||||
|
||||
## Building
|
||||
# Building
|
||||
|
||||
## Any platform/arch
|
||||
|
||||
With Go 1.12 installed, from this directory:
|
||||
|
||||
export GOPATH=$(pwd)
|
||||
go build ./src/hockeypuck/server/cmd/...
|
||||
go install ./src/hockeypuck/server/cmd/...
|
||||
|
||||
Hockeypuck binaries will be in `bin/`.
|
||||
|
||||
## Ubuntu package maintainers
|
||||
|
||||
To locally build the hockeypuck binaries:
|
||||
|
||||
make install-build-depends
|
||||
make
|
||||
|
||||
## Building a Release
|
||||
# Releases
|
||||
|
||||
## Ubuntu package maintainers
|
||||
|
||||
In order to release a new version of hockeypuck:
|
||||
|
||||
@ -24,6 +38,18 @@ In order to release a new version of hockeypuck:
|
||||
Where `x.y.z` is the appropriate version number.
|
||||
This will upload the debian source package to the Launchpad PPA for building.
|
||||
|
||||
# Running
|
||||
|
||||
## Quick start with Docker
|
||||
|
||||
Easiest way to run Hockeypuck locally is with `docker-compose`:
|
||||
|
||||
docker-compose up
|
||||
|
||||
# About
|
||||
|
||||
Copyright 2019, The Hockeypuck Developers; see CONTRIBUTORS and LICENSE for details.
|
||||
|
||||
## Vendored Dependencies
|
||||
|
||||
The dependencies for this project are managed via Go modules.
|
||||
@ -35,3 +61,4 @@ To update the dependencies run:
|
||||
|
||||
After which you can ensure that the code continues to build and
|
||||
that the tests still pass.
|
||||
|
||||
|
2
debian/copyright
vendored
2
debian/copyright
vendored
@ -4,7 +4,7 @@ Upstream-Contact: Casey Marshall <cmars@cmarstech.com>
|
||||
Source: https://github.com/hockeypuck/hockeypuck
|
||||
|
||||
Files: *
|
||||
Copyright: 2012-2015 Casey Marshall <cmars@cmarstech.com>
|
||||
Copyright: 2012-2019 Casey Marshall <cmars@cmarstech.com>
|
||||
Comment: Where not otherwise specified by included third-party package
|
||||
dependencies, these terms apply to all files in the package.
|
||||
License: AGPL-3
|
||||
|
Loading…
x
Reference in New Issue
Block a user