Skip to content

Commit

Permalink
Improve instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
jonahbeckford committed Sep 14, 2023
1 parent e90732e commit 9dbcb3f
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 4 deletions.
10 changes: 10 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,13 @@ _build/

# direnv (https://direnv.net/)
.envrc

# CI using dkml-workflows' DkML compilers.
# DkML compilers populate the .opam folder.
/.opam/
# GitHub, unlike GitLab, does not need its CI files to exist
# before referencing them. That means the GitHub scripts do not need
# to be checked in.
/.ci/dkml-compilers/gh-*
# Desktop testing on Windows uses MSYS2.
/msys64/
18 changes: 14 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ Create the file if it doesn't already exist:
*.sln text eol=crlf
```
FOURTH, create the scaffolding files with one of the following options:
FOURTH, create the scaffolding files with **one** of the following options:
```sh
# Let's get help to see what will happen
Expand All @@ -143,13 +143,23 @@ FOURTH, create the scaffolding files with one of the following options:
./dk dkml.workflow.compilers CI GitLab Desktop
```
And then commit the new files that were created.
And then commit the new files that were created:
```sh
git add -A
git update-index --chmod=+x ./dk ci/build-test.sh
git commit -m "ci: DkML compilers"
```
### `ci/build-test.sh`
Your build logic will be inside the `ci/build-test.sh` POSIX shell script. This will work even on Windows; just be careful on Windows that you save the shell script with LF line endings (not CRLF), and use UTF-8 encoding.
The `./dk dkml.workflow.compilers ...` command will have created a `ci/build-test.sh` POSIX shell script for you if it wasn't present already.
Your build logic will be inside the `ci/build-test.sh` script. This will work even on Windows; just be careful on Windows that you save the shell script with **LF line endings (not CRLF), and use UTF-8 encoding**.
The [Examples](#examples) section has comprehensive examples.
You don't need to name the file `ci/build-test.sh` however the documentation and the auto-generated scripts (which you can change) assumes that filename.
*The script does not need to be named `ci/build-test.sh`. However the documentation and the auto-generated scripts (which you can change) assumes that filename.*
## Examples
Expand Down

0 comments on commit 9dbcb3f

Please sign in to comment.