Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README #711

Merged
merged 3 commits into from
Oct 16, 2024
Merged

Update README #711

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
424f679
Update README
cole-miller Oct 16, 2024
01b3efb
Remove red herring GPG workaround
cole-miller Oct 16, 2024
7643fdf
Tweak CONTRIBUTING.md
cole-miller Oct 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions .github/workflows/packages.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,9 @@ jobs:
sudo apt-get update -qq
sudo apt-get install -qq debhelper devscripts gnupg
- name: Work around GPG issue
run: |
mkdir -p ~/.gnupg
echo "pinentry-mode loopback" >~/.gnupg/gpg.conf
# Note for future maintainers: the secret key should be stored
# in the GHA secret in ASCII-armored form, and must not be
# password-protected.
- name: Setup GPG signing key
env:
PPA_SECRET_KEY: ${{ secrets.PPA_SECRET_KEY }}
Expand Down
9 changes: 4 additions & 5 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
# Contributing to dqlite

The dqlite team welcomes external contributions via GitHub pull
requests. To get your PR merged, you need to sign [Canonical's
contributor license agreement (CLA)][cla]. This is straightforward to
do once you have an account on [Launchpad][lp]; if you don't, you can
create one [here][signup].
The dqlite team welcomes contributions via GitHub pull requests. To get your PR
merged, you need to sign [Canonical's contributor license agreement
(CLA)][cla]. This is straightforward to do once you have an account on
[Launchpad][lp]; if you don't, you can create one [here][signup].

[cla]: https://ubuntu.com/legal/contributors
[lp]: https://launchpad.net
Expand Down
10 changes: 3 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ library and headers as follows:

```
$ autoreconf -i
$ ./configure --enable-build-raft
$ ./configure
$ make
$ sudo make install
```
Expand All @@ -112,13 +112,9 @@ to enable the linker to find `libdqlite.so`. To install to a different prefix,
replace the configure step with something like

```
$ ./configure --enable-build-raft --prefix=/usr
$ ./configure --prefix=/usr
```

The `--enable-build-raft` option causes dqlite to use its bundled Raft
implementation instead of linking to an external libraft; the latter is a
legacy configuration that should not be used for new development.

Building for static linking
---------------------------

Expand All @@ -141,7 +137,7 @@ The `contrib/build-static.sh` script demonstrates building and
testing dqlite with all dependencies (including libc) statically
linked.

Usage Notes
Usage notes
-----------

Detailed tracing will be enabled when the environment variable
Expand Down
Loading