Skip to content
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.

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

Tidy docs #682

Merged
merged 1 commit into from
Aug 23, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion docs/ABOUT.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ C is commonly found in low level applications as it's a good alternative to hard
It can be compiled to assembly to keep the same level of performance, while increasing readability, and providing a small level of safety with static types!

C was created by Dennis Ritchie at Bell Labs, and used to re-implement the Unix operating system.
Now, it's one of the most used programming languages, with many compilers supporting providing support for most available hardware and platforms - there's plenty of resources and support available to help you get started!
Now, it's one of the most used programming languages, with many compilers providing support for most available hardware and platforms - there's plenty of resources and support available to help you get started!
2 changes: 1 addition & 1 deletion docs/INSTALLATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,6 @@ Windows 10 users are recommended to use the [Windows Subsystem for Linux][], and
If you are using an earlier version of Windows or WSL Bash is not available to you, you could use [MSYS][] or [mingw-w64][].

[Homebrew]: https://brew.sh
[Windows Subsystem for Linux]: https://msdn.microsoft.com/en-us/commandline/wsl/about
[Windows Subsystem for Linux]: https://docs.microsoft.com/en-gb/windows/wsl/about
[MSYS]: https://www.msys2.org/
[mingw-w64]: http://mingw-w64.org/doku.php
3 changes: 2 additions & 1 deletion docs/TESTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,8 @@ $ make

This will compile your code, and run the tests.

The `makefile` comes also with a build that checks some common mistakes regarding memory leaks and out of bound access to arrays. To run these checks, use the following at the command line:
The `makefile` comes also with a build that checks some common mistakes regarding memory leaks and out of bound access to arrays.
To run these checks, use the following at the command line:

```console
$ make memcheck
Expand Down
2 changes: 1 addition & 1 deletion exercises/shared/.docs/tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Get the first test compiling, linking and passing by following the [three rules
The included makefile can be used to create and run the tests using the `test` task.

```console
make test
$ make test
```

Create just the functions you need to satisfy any compiler errors and get the test to fail.
Expand Down