Commit Graph

11 Commits

Author SHA1 Message Date
Ben Roeder
a62fe80c3f Fix spelling errors throughout codebase
Corrected various spelling mistakes in comments, documentation, and
variable names across the project. Changes include:
- Documentation files (CONTRIBUTING.md, README.md, etc.)
- Source code comments in C/C++ files
- Function parameter names and descriptions

No functional changes were made.
2025-06-01 18:03:40 +01:00
Martin Pulec
281d85b15f vcomp/gpujpeg: accept opt prefix
Also advertise (only) the key/value syntax in usage.

\+ removed Macros from clang-tidy suggestion in CONTRIBUTING.md -
doesn't seem to perform better as for the changed line in this commit
(color_printf)
2024-06-06 11:05:35 +02:00
Martin Pulec
026e898c09 updated documentation + gitignore
- added RCS, .clang-tidy and .editorconfig to .gitignore in order to
allow user to define own (not enforce for now)
- however, updated a suggested clant-tidy config in documentation
- also in CONTRIBUTING.md - add more clarification regarding pull
requests
- also suggested function-like macros to be upper-case - there doesn't
seem to be a general convention for that, but it seems to be better to
me, since it reduces the collision space (eg. MAX vs std::max) while
making more clear that this is a macro
2024-05-31 16:04:42 +02:00
Martin Pulec
9be9e8af5d CONTRIBUTING.md: naming convertion for mod. logger 2023-11-06 13:28:16 +01:00
Martin Pulec
ca8d0bc1cf updated coding style
+ added .clang-format to .gitignore

The style respects mostly rtp/rtp.{c,h} coding style (original
UltraGrid).

Rather than specifying own style, deduce one from clang-format default
format (just keeping the indention 8 spaces). The style is quite
restrictive because indention of 8 spaces + line with 80 restricts
nesting quite a bit.

Anyways, the style is rather a recommendation and is not enforced in any
way - .clang-format is just added to .gitignore and the developer can
tweak it a bit (like extending ColumnLimit).
2023-06-21 10:56:49 +02:00
Martin Pulec
a15533d44a updated bug reporting documentation 2022-11-11 11:26:58 +01:00
Martin Pulec
f6c98f4813 Removed Matrix room references
It was seldom used, point to GitHub discussions instead.
2021-01-06 16:00:11 +01:00
Martin Pulec
72bc7c45a0 Updated documentation 2020-10-08 11:06:20 +02:00
Martin Pulec
928e0202d2 Added Matrix badge
+ added link to a Matrix room to CONTRIBUTING.md
2020-03-03 14:49:03 +01:00
Martin Pulec
4c4e333b05 CONTRIBUTING.md: added TOC + updates 2019-11-05 17:35:10 +01:00
Martin Pulec
6257703d9a Replaced coding_standards.html with CONTRIBUTING.md
And extending it somehow.
2019-11-01 11:32:36 +01:00