averello/Bear-mirror
1
0
Fork 0
mirror of https://github.com/rizsotto/Bear.git synced 2025-12-12 20:35:47 +01:00
Code Issues Packages Projects Releases Wiki Activity

Fix grammar and punctuation in README.md

Browse Source 
Correct grammar and punctuation throughout the README file for clarity.
This commit is contained in:
frogtd
2025-10-21 15:27:04 -04:00
committed by László Nagy
parent 8bf857ffa9
commit 71810e9ba8
1 changed files with 20 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
README.md
View File

@@ -5,18 +5,18 @@
[![Contributors](https://img.shields.io/github/contributors/rizsotto/Bear)](https://github.com/rizsotto/Bear/graphs/contributors)
[![Gitter](https://img.shields.io/gitter/room/rizsotto/Bear)](https://gitter.im/rizsotto/Bear)
ʕ·ᴥ·ʔ Build EAR
ʕ·ᴥ·ʔ Build EAR
===============
Bear is a tool that generates a compilation database for clang tooling.
The [JSON compilation database][JSONCDB] is used in the clang project
to provide information on how a single compilation unit is processed.
With this, it is easy to re-run the compilation with alternate programs.
The [JSON compilation database][JSONCDB] is used in the clang project to
provide information on how a single compilation unit is processed. With this,
it is easy to re-run the compilation with alternate programs.
Some build system natively supports the generation of JSON compilation
database. For projects which does not use such build tool, Bear generates
the JSON file during the build process.
Some build systems natively support the generation of a JSON compilation
database. For projects that do not use such a build tool, Bear generates the
JSON file during the build process.
[JSONCDB]: http://clang.llvm.org/docs/JSONCompilationDatabase.html
@@ -30,32 +30,32 @@ from source.
How to use
----------
After installation the usage is like this:
After installation, use Bear like this:
bear -- <your-build-command>
The output file called `compile_commands.json` is saved in the current directory.
The output file, `compile_commands.json`, is saved in the current directory.
For more options you can check the man page or pass `--help` parameter. Note
that if you want to pass parameter to Bear, pass those _before_ the `--` sign,
everything after that will be the build command.
For more options, check the man page or pass the `--help` parameter. Note that
if you want to pass parameters to Bear, pass those _before_ the `--` sign,
everything after that will be the build command.
Please be aware that some package manager still ship our old 2.4.x release.
In that case please omit the extra `--` sign or consult your local documentation.
Please be aware that some package managers still ship our old 2.4.x release. In
that case, please omit the extra `--` sign or consult your local documentation.
For more, read the man pages or [wiki][WIKI] of the project, which talks about
limitations, known issues and platform specific usage.
limitations, known issues and platform-specific usage.
Problem reports
---------------
Before you open a new problem report, please look at the [wiki][WIKI] if your
problem is a known one with documented workaround. It's also helpful to look
at older (maybe closed) [issues][ISSUES] before you open a new one.
problem is a known one with a documented workaround. It's also helpful to look
at older (maybe closed) [issues][ISSUES] before you open a new one.
If you decided to report a problem, try to give as much context as it would
help me to reproduce the error you see. If you just have a question about the
usage, please don't be shy, ask your question in an issue or in [chat][CHAT].
If you decide to report a problem, try to give as much context as possible to
help me reproduce the error you see. If you have a question about usage, please
don't be shy, ask your question in an issue or in [chat][CHAT].
If you found a bug, but also found a fix for it, please share it with me and
open a pull request.