From 799423c088f1d1b1e273ee9f7279da879555b6aa Mon Sep 17 00:00:00 2001 From: James Brock Date: Tue, 15 Oct 2024 21:06:39 +0900 Subject: [PATCH] README console --- conformance/README.md | 6 ++++-- test/README.md | 16 ++++++++++++---- 2 files changed, 16 insertions(+), 6 deletions(-) diff --git a/conformance/README.md b/conformance/README.md index c834461..affa31e 100644 --- a/conformance/README.md +++ b/conformance/README.md @@ -4,7 +4,7 @@ From the top directory of this repo, -``` +```console nix run .#conformance ``` @@ -19,7 +19,9 @@ The derivations in `nix/protobuf.nix` will build `protoc` and the To generate the conformance `.purs` in the dev environment: -``` +```console protoc --purescript_out=./conformance/generated --proto_path=$(nix path-info .#protobuf)/conformance $(nix path-info .#protobuf)/conformance/conformance.proto +``` +```console protoc --purescript_out=./conformance/generated --proto_path=$(nix path-info .#protobuf)/src $(nix path-info .#protobuf)/src/google/protobuf/test_messages_proto3.proto ``` \ No newline at end of file diff --git a/test/README.md b/test/README.md index b6cfad8..b956eff 100644 --- a/test/README.md +++ b/test/README.md @@ -6,13 +6,21 @@ To test purescript-protobuf, run `nix develop` from the top level directory of the repo, then: - spago -x spago-plugin.dhall build - protoc --purescript_out=./test/generated test/*.proto - spago -x spago-test.dhall test +```console +spago -x spago-plugin.dhall build +``` +```console +protoc --purescript_out=./test/generated test/*.proto +``` +```console +spago -x spago-test.dhall test +``` # Benchmarks To run the benchmarks, run `nix develop` from the top level directory, then: - spago -x spago-test.dhall run --main Test.Bench +```console +spago -x spago-test.dhall run --main Test.Bench +```