Skip to content

Update README; add .mailmap #39

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
cxw42 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README; add .mailmap #39

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .mailmap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Chris White <cxwembedded@gmail.com> <chrisw@leehayes.com>
Hong Xu <hong@topbug.net> Hong <hong@topbug.net>
Hong Xu <hong@topbug.net> <dev@hong.me>
Hong Xu <hong@topbug.net> <xuhdev@gmail.com>
Jed Mao <jedmao@outlook.com> <jedmao@users.noreply.github.com>
Trey Hunner <treyhunner@gmail.com> <trey@treyhunner.com>
30 changes: 19 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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/