Skip to content

Commit

Permalink
Grammar edits to README.md (radareorg#11713)
Browse files Browse the repository at this point in the history
* Fixes a couple of grammar mistakes in AUTHORS.md
* Grammar fix in CONTRIBUTING.md
* Fixes multiple grammar errors in DEVELOPERS.md
* Caps the character length in a edit I made.
  • Loading branch information
ItzSomebody authored and radare committed Oct 2, 2018
1 parent d997fb6 commit e8b1a20
Show file tree
Hide file tree
Showing 4 changed files with 44 additions and 44 deletions.
4 changes: 2 additions & 2 deletions AUTHORS.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Authors
Main developer (author and maintainer)
--------------------------------------

The author of radare and radare2, is the main contributor and designer of the tool, apis, bindings, etc
The author of radare and radare2 is the main contributor and designer of the tool, apis, bindings, etc.

- pancake <[email protected]>

Expand Down Expand Up @@ -94,7 +94,7 @@ This release comes with contributions from the following people:
Previous contributors
---------------------

Some people didn't contributed to the last release, but they did it for the past ones. Kudos for them too!
Some people didn't contribute to the lastest release, but they did it for the past ones. Kudos for them too!

- 0xroot
- Alexander
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ Before reporting an issue with GitHub, be sure that:
* you are using a clean installation
* the issue was not already reported

When the above conditions are satisfied, feel free to submit an issue,
trying to be as precise as possible. If you can, provide the problematic
When the above conditions are satisfied, feel free to submit an issue
while trying to be as precise as possible. If you can, provide the problematic
binary, the steps to reproduce the error and a backtrace in case of SEGFAULTs.
Any information will help to fix the problem.

Expand Down
52 changes: 26 additions & 26 deletions DEVELOPERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@ on the code base of radare2 project.

## Documentation
There is support for Doxygen document generation in this repo.
By running `doxygen` in the root of this repository it will autodetect the
By running `doxygen` in the root of this repository, it will autodetect the
Doxyfile and generate HTML documentation into
[doc/doxygen/html/index.html](./doc/doxygen/html/index.html)

If you're contributing code or willing to update existing code you can use the
doxygen C style comments to improve documentation and comments in code.
If you're contributing code or willing to update existing code, you can use the
doxygen C-style comments to improve documentation and comments in code.
See the [Doxygen Manual](https://www.stack.nl/~dimitri/doxygen/manual/index.html)
for more info. Example usage can be found [here](https://www.stack.nl/~dimitri/doxygen/manual/docblocks.html)
```c
Expand All @@ -33,13 +33,13 @@ static int findMinMax(RList *maps, ut64 *min, ut64 *max, int skip, int width);
### C
In order to contribute with patches or plugins we encourage you to
In order to contribute with patches or plugins, we encourage you to
use the same coding style as the rest of the code base.
Please use `./sys/clang-format-diff.py` before submitting a PR, to be sure to
follow the coding style. If you find a bug in this script, please create an
issue on GitHub. You can also install the pre-commit hook
`./sys/pre-commit-indent.sh` by copying it in `.git/hooks/pre-commit`, so it
Please use `./sys/clang-format-diff.py` before submitting a PR to be sure you
are following the coding style. If you find a bug in this script, please create
an issue on GitHub. You can also install the pre-commit hook
`./sys/pre-commit-indent.sh` by copying it in `.git/hooks/pre-commit` which
will check the coding style of the modified lines before committing them.
You may find some additional notes on this topic in doc/vim.
Expand Down Expand Up @@ -92,14 +92,14 @@ if (a == b) {

* In general, don't use goto. The goto statement only comes in handy when a
function exits from multiple locations and some common work such as cleanup
has to be done. If there is no cleanup needed then just return directly.
has to be done. If there is no cleanup needed, then just return directly.

Choose label names which say what the goto does or why the goto exists. An
example of a good name could be "out_buffer:" if the goto frees "buffer".
Avoid using GW-BASIC names like "err1:" and "err2:".

* Use `r_return_*` functions to check preconditions that are caused by
programmers errors. Please note the difference between conditions that should
programmers' errors. Please note the difference between conditions that should
never happen, and that are handled through `r_return_*` functions, and
conditions that can happen at runtime (e.g. malloc returns NULL, input coming
from user, etc.), and should be handled in the usual way through if-else.
Expand Down Expand Up @@ -162,7 +162,7 @@ a = (b << 3) * 5;
* Why return int vs enum
The reason why many places in r2land functions return int instead of an enum type is because enums cant be OR'ed because it breaks the usage within a switch statement and also because swig cant handle that stuff.
The reason why many places in r2land functions return int instead of an enum type is because enums cant be OR'ed; otherwise, it breaks the usage within a switch statement and swig cant handle that stuff.
```
r_core_wrap.cxx:28612:60: error: assigning to 'RRegisterType' from incompatible type 'long'
Expand Down Expand Up @@ -199,7 +199,7 @@ r_core_wrap.cxx:32103:61: error: assigning to 'RDebugReasonType' from incompatib
* If you *really* need to comment out some code, use #if 0 (...) #endif. In
general, don't comment out code because it makes the code less readable.
* Do not write ultra-large functions, split them into multiple or simplify
* Do not write ultra-large functions: split them into multiple or simplify
the algorithm, only external-copy-pasted-not-going-to-be-maintained code
can be accepted in this way (gnu code, external disassemblers, etc..)
Expand Down Expand Up @@ -318,10 +318,10 @@ into `.dir-locals.el`.
The radare2 code base is modularized into different libraries that are
found in libr/ directory. The binr/ directory contains the programs
that use the libraries.
which use the libraries.
It is possible to generate PIC/nonPIC builds of the libraries and also
to create a single static library, so you can use a single library
to create a single static library so you can use a single library
archive (.a) to link your programs and get your programs using radare
framework libraries without depending on them. See doc/static for more info.
Expand Down Expand Up @@ -371,18 +371,18 @@ The source of radare2 can be found in the following github repository.
```sh
git clone git://github.com/radare/radare2
```
Other packages radare2 depends on, such as Capstone, are pull from
Other packages radare2 depends on, such as Capstone, are pulled from
their git repository as required.
To get an up to date copy of the repository you should perform the
To get an up-to-date copy of the repository, you should perform the
following steps:
```sh
git pull
```
If you have conflicts in your local copy it's because you have modified
If you have conflicts in your local copy, it's because you have modified
files which are conflicting with the incoming patchsets. To get a clean
source directory type the following command:
source directory, type the following command:
```sh
git clean -xdf
git reset --hard
Expand All @@ -396,10 +396,10 @@ require human interaction to recompile the affected modules.
This is a common issue and can end up having outdated libraries trying
to use deprecated structures which may result into segfaults.
You have to make clean on the affected modules or just, if you are not
sure enough that everything is ok just make clean the whole project.
You have to make clean on the affected modules. If you are not
sure enough that everything is OK, just make clean the whole project.
If you want to accelerate the build process after full make cleans
If you want to accelerate the build process after full make cleans,
you should use ccache in this way:
```
export CC="ccache gcc"
Expand All @@ -409,7 +409,7 @@ you should use ccache in this way:
Developers use to modify the code, type make and then try.
radare2 have a specific makefile target that allows you to install
radare2 has a specific makefile target that allows you to install
system wide but using symlinks instead of hard copies.
```sh
sudo make symstall
Expand All @@ -430,8 +430,8 @@ following github repository.
See the `README.md` file in that repository for further information.
The existing test coverage can always do with improvement, so if you can
contribute additions tests that would be gratefully accepted.
The existing test coverage can always do with improvement. So if you can
contribute additions tests, that would be gratefully accepted.
## Reporting bugs
Expand All @@ -442,7 +442,7 @@ by this framework.
You should report it into the github issues page.
https://github.com/radare/radare2/issues
Otherwise, if you are looking for some more feedback I will
Otherwise, if you are looking for some more feedback, I will
encourage you to send an email to any of the emails enumerated
in the AUTHORS file.
Expand All @@ -451,7 +451,7 @@ in a public place: join the #radare channel on irc.freenode.net.
The issues page of Github contains a list of all the bugs that
have been reported classified with labels by difficulty, type,
milestone, etc. it is a good place to start if you are looking
milestone, etc. It is a good place to start if you are looking
to contribute.
## Contributing with patches
Expand Down
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ using root privileges and sudo, simply run:

# Building with meson + ninja

If you don't already have meson and ninja you can install them
If you don't already have meson and ninja, you can install them
with your distribution package manager or with r2pm:

$ r2pm -i meson
Expand All @@ -102,8 +102,8 @@ with Makefile is not suitable. If you are lost in any way, just type:

# Update

To update Radare2 system wide you don't need to uninstall or pull,
just re-run:
To update Radare2 system-wide, you don't need to uninstall or pull.
Just re-run:

$ sys/install.sh

Expand All @@ -114,7 +114,7 @@ just re-run:

# Uninstall

In case of a polluted filesystem you can uninstall the current
In case of a polluted filesystem, you can uninstall the current
version or remove all previous installations:

$ make uninstall
Expand All @@ -126,17 +126,17 @@ To remove all stuff including libraries, use

# Package manager

Radare2 has its own package manager - r2pm. It's packages
Radare2 has its own package manager - r2pm. Its packages
repository is on [GitHub too](https://github.com/radare/radare2-pm).
To start to use it for the first time you need to initialize packages:
To start to using it for the first time, you need to initialize packages:

$ r2pm init

Refresh the packages database before installing any package:

$ r2pm update

To install a package use the following command:
To install a package, use the following command:

$ r2pm install [package name]

Expand All @@ -155,10 +155,10 @@ The easiest way to install the python bindings is to run:
$ r2pm install r2api-python
$ r2pm install r2pipe-py

In addition there are `r2pipe` bindings, which are an API
In addition there are `r2pipe` bindings, which is an API
interface to interact with the prompt, passing commands
and receivent the output as a string, many commands support
JSON output, so it's integrated easily with many languages
JSON output, so its integrated easily with many languages
in order to deserialize it into native objects.

$ npm install r2pipe # NodeJS
Expand All @@ -171,9 +171,9 @@ Vala, OCaml, and many more to come!

# Regression Testsuite

Running `make tests` it will fetch the radare2-regressions
Running `make tests` will fetch the radare2-regressions
repository and run all the tests in order to verify that no
changes break a functionality.
changes break any functionality.

We run those tests on every commit, and they are also
executed with ASAN and valgrind on different platforms
Expand All @@ -188,7 +188,7 @@ appending '?' to every command you are interested in.

Commands are small mnemonics of few characters and there is
some extra syntax sugar that makes the shell much more pleasant
for scripting and interacting with the apis.
for scripting and interacting with the APIs.

You could also checkout the [radare2 book](https://radare.gitbooks.io/radare2book/content/).

Expand All @@ -198,14 +198,14 @@ Look at [CONTRIBUTING.md](https://github.com/radare/radare2/blob/master/CONTRIBU

# Webserver

radare2 comes with an embedded webserver that serves a pure
radare2 comes with an embedded webserver which serves a pure
html/js interface that sends ajax queries to the core and
aims to implement an usable UI for phones, tablets and desktops.

$ r2 -c=H /bin/ls

To use the webserver on Windows, you require a cmd instance
with administrator rights. To start the webserver use command
with administrator rights. To start the webserver, use the following command
in the project root.

> radare2.exe -c=H rax2.exe
Expand Down

0 comments on commit e8b1a20

Please sign in to comment.