Skip to content

Commit

Permalink
Update README; add .mailmap
Browse files Browse the repository at this point in the history
- Update README: fix some typos, and mention the versioning tie-in with
  the specification after editorconfig/editorconfig-vote#11.
- Add .mailmap: this way the automatically-generated Git lists of
  authors and committers only have one entry per person.
  • Loading branch information
cxw42 committed Oct 30, 2022
1 parent 70840cf commit 7ff4966
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 11 deletions.
6 changes: 6 additions & 0 deletions .mailmap
@@ -0,0 +1,6 @@
Chris White <[email protected]> <[email protected]>
Hong Xu <[email protected]> Hong <[email protected]>
Hong Xu <[email protected]> <[email protected]>
Hong Xu <[email protected]> <[email protected]>
Jed Mao <[email protected]> <[email protected]>
Trey Hunner <[email protected]> <[email protected]>
30 changes: 19 additions & 11 deletions README.md
@@ -1,16 +1,18 @@
This project is a series of testing for [EditorConfig Core][editorconfig]. Please have
[cmake][] installed before using this project.
# editorconfig-core-test

### Use editorconfig-core-test independently
This project is a series of tests for [EditorConfig][] cores.
Please have [cmake][] installed before using this project.

## Use editorconfig-core-test independently

After installing cmake, switch to the root dir of this project, and execute:

cmake -DEDITORCONFIG_CMD=the_editorconfig_core_cmd_you_want_to_test .

After that, if testing files are generated successfully, execute `ctest .` to
start testings.
After that, if the test files have been generated successfully, execute
`ctest .` to start testing.

### Use editorconfig-core-test in your project as a git submodule
## Use editorconfig-core-test in your project as a git submodule

If you are using [git][] and cmake to manage your project, this method should
be suitable for you.
Expand All @@ -29,9 +31,15 @@ set(EDITORCONFIG_CMD the_editorconfig_core_path)
add_subdirectory(tests)
```

Now after executing `cmake .` in you project root dir, you should be able to
run the testings by executing `ctest .`.
Now after executing `cmake .` in your project root dir, you should be able to
run the tests by executing `ctest .`.

## Versioning

The version of this repository matches the version of the EditorConfig
[specification][].

[cmake]: http://www.cmake.org
[editorconfig]: http://editorconfig.org
[git]: http://git-scm.com
[cmake]: https://www.cmake.org
[EditorConfig]: https://editorconfig.org
[git]: https://git-scm.com
[specification]: https://editorconfig-specification.readthedocs.io/en/latest/

0 comments on commit 7ff4966

Please sign in to comment.