This is an automated email from the ASF dual-hosted git repository.
fanningpj pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-pekko-http.git
The following commit(s) were added to refs/heads/main by this push:
new d604de618 note about h2spec and Mac Silicon (#264)
d604de618 is described below
commit d604de6186736b015345da6addc946f68ea5a4bb
Author: PJ Fanning <[email protected]>
AuthorDate: Mon Jul 24 08:56:26 2023 +0100
note about h2spec and Mac Silicon (#264)
---
CONTRIBUTING.md | 8 ++------
README.md | 7 +++++++
2 files changed, 9 insertions(+), 6 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 46d85377c..246b8b8ad 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -4,13 +4,9 @@ We follow the standard GitHub [fork &
pull](https://help.github.com/articles/usi
You're always welcome to submit your PR straight away and start the discussion
(without reading the rest of this wonderful doc, or the README.md). The goal of
these notes is to make your experience contributing to Pekko HTTP as smooth and
pleasant as possible. We're happy to guide you through the process once you've
submitted your PR.
-# The Apache Pekko Community
+# Introduction
-If you have questions about the contribution process or discuss specific
issues, please interact with the community using the following resources.
-
-- [GitHub
discussions](https://github.com/apache/incubator-pekko-http/discussions): for
questions and general discussion.
-- [Pekko dev mailing
list](https://lists.apache.org/[email protected]): for Pekko
development discussions.
-- [GitHub issues](https://github.com/apache/incubator-pekko-http/issues): for
bug reports and feature requests. Please search the existing issues before
creating new ones. If you are unsure whether you have found a bug, consider
asking in GitHub discussions or the mailing list first.
+The [README](README.md) has details about the Pekko Community and building
from source.
# Navigating around the project & codebase
diff --git a/README.md b/README.md
index 303c3323b..bf19316b1 100644
--- a/README.md
+++ b/README.md
@@ -35,6 +35,13 @@ The documentation is available at
- Make sure you have [sbt](https://www.scala-sbt.org/) installed.
- [Graphviz](https://graphviz.gitlab.io/download/) is needed for the scaladoc
generation build task, which is part of the release.
+### h2spec
+
+Some tests for HTTP/2 compliance use
[h2spec](https://github.com/summerwind/h2spec). The sbt build downloads
+pre-built binaries from the GitHub releases page for the h2spec project. These
binaries are not available for all
+operating systems. In particular, we have received reports of issues with
running the tests on Apple Mac Silicon
+machines.
+
### Running the Build
- Open a command window and change directory to your preferred base directory
- Use git to clone the [repo](https://github.com/apache/incubator-pekko-http)
or download a source release from https://pekko.apache.org (and unzip or untar
it, as appropriate)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
