Skip to content

Commit 9f2a454

Browse files
committed
docs: Address review comments by @Zimmi48
1 parent d9f7aa0 commit 9f2a454

File tree

2 files changed

+10
-7
lines changed

2 files changed

+10
-7
lines changed

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,10 @@ configuration and boilerplate files in the
3434
[AAC Tactics](https://github.com/coq-community/aac-tactics)
3535
project are generated as follows:
3636
```shell
37-
mustache meta.yml ../templates/default.nix.mustache > default.nix
3837
mustache meta.yml ../templates/README.md.mustache > README.md
39-
mustache meta.yml ../templates/.travis.yml.mustache > .travis.yml
4038
mustache meta.yml ../templates/coq.opam.mustache > coq-aac-tactics.opam
41-
mkdir -p .github/workflows
42-
mustache meta.yml ../templates/coq-action.yml.mustache > .github/workflows/coq-action.yml
39+
mustache meta.yml ../templates/default.nix.mustache > default.nix
40+
mustache meta.yml ../templates/.travis.yml.mustache > .travis.yml
4341
```
4442
Other projects using the templates in a similar way include
4543
[Chapar](https://github.com/coq-community/chapar) and
@@ -54,6 +52,14 @@ cd -
5452
../templates/generate.sh
5553
git add <the_generated_files>
5654
```
55+
Regarding continuous integration, the `generate.sh` script will create:
56+
* a [Travis CI](https://docs.travis-ci.com/) configuration
57+
[(based on opam + Nix)](./.travis.yml.mustache),
58+
* or a [GitHub Action](https://help.github.com/en/actions) workflow
59+
[(based on opam)](./coq-action.yml.mustache),
60+
61+
whether `meta.yml` contains `travis: true` or `action: true`.
62+
5763
Keeping generated files under version control is not ideal, but `README.md` has to exist,
5864
and generally this is a common practice when using build systems such as Autotools.
5965
To get a `mustache` tool in, e.g., NixOS, you can run `nix-env -i mustache-go`.

generate.sh

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,6 @@
22

33
srcdir=$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null && pwd )
44

5-
# ask1() { local yn; echo -n "$* [Y/n] "; read -r -n 1 yn; [[ "$yn" =~ [Yy] ]] && echo && return 0; [ -z "$yn" ] && return 0; echo; return 1; }
6-
# if ask1 "Question?"; then ...; else ...; fi
7-
85
get_yaml() {
96
# Arg 1: the meta.yml path
107
# STDIN: the mustache code

0 commit comments

Comments
 (0)