Skip to content

Commit

Permalink
Merge pull request sstephenson#159 from bvberkum/forks/bvb-docs
Browse files Browse the repository at this point in the history
Minor ReadMe improvement testing (sstephenson#157), contributing, contact sections.
  • Loading branch information
sublimino authored Nov 8, 2018
2 parents e1e6f8d + 9007eec commit 5eb45c1
Showing 1 changed file with 24 additions and 6 deletions.
30 changes: 24 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,12 +64,14 @@ commit [0360811][]. It was created via `git clone --bare` and `git push
- [File descriptor 3 (read this if Bats hangs)](#file-descriptor-3-read-this-if-bats-hangs)
- [Printing to the terminal](#printing-to-the-terminal)
- [Special variables](#special-variables)
- [Testing](#testing)
- [Support](#support)
- [Contributing](#contributing)
- [Contact](#contact)
- [Version history](#version-history)
- [Background](#background)
- [Why was this fork created?](#why-was-this-fork-created)
- [What's the plan and why?](#whats-the-plan-and-why)
- [Contact us](#contact-us)
- [Copyright](#copyright)

## Installation
Expand Down Expand Up @@ -429,6 +431,14 @@ There are several global variables you can use to introspect on Bats tests:
* `$BATS_TMPDIR` is the location to a directory that may be used to store
temporary files.

## Testing

```sh
bin/bats --tap test
```
See also the [CI](.travis.yml) settings for the current test environment and
scripts.

## Support

The Bats source code repository is [hosted on
Expand All @@ -443,12 +453,20 @@ To learn how to set up your editor for Bats syntax highlighting, see [Syntax
Highlighting](https://github.com/bats-core/bats-core/wiki/Syntax-Highlighting)
on the wiki.

## Contributing

For now see the ``docs`` folder for project guides, work with us on the wiki
or look at the other communication channels.

## Contact

- We are `#bats` on freenode;
- Or leave a message on [gitter].

## Version history

See `docs/CHANGELOG.md`.

---

## Background

### Why was this fork created?
Expand Down Expand Up @@ -485,9 +503,6 @@ Doing it this way accomplishes a number of things:
1. Prevents lock-out by giving administrative access to more than one person,
increases transferability

### Contact us

- We are `#bats` on freenode

## Copyright

Expand All @@ -497,4 +512,7 @@ Doing it this way accomplishes a number of things:

Bats is released under an MIT-style license; see `LICENSE.md` for details.

See the [parent project](https://github.com/bats-core) at GitHub or the
[AUTHORS](AUTHORS) file for the current project maintainer team.

[gitter]: https://gitter.im/bats-core/bats-core?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge

0 comments on commit 5eb45c1

Please sign in to comment.