Skip to content

Commit

Permalink
Basic contributing documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
judfs authored and nosracd committed Jan 3, 2024
1 parent 010e09c commit 5b83115
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
build*/
__pycache__

docs/_build/

.vscode/
.idea/
Expand Down
7 changes: 7 additions & 0 deletions docs/content/contributing-c.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Contributing C

Run `./format_code.sh` before committing to format the code.

## Code Quality

Code in the directory `lcmgen` leaks memory. It is not an uncommon practice to allow this for short lived CLI tools.
6 changes: 6 additions & 0 deletions docs/content/contributing-java.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Contributing Java

`lcm.jar` along with `lcm-spy` and `lcm-logplayer-gui` are built with Cmake. There is not a Ant/Maven/Gradle project.
To edit the code, use your IDE of choice to create a project in the `lcm-java` folder. `lcm-java/lcm` should be the top level package (`lcm.lcm.LCM` is the fully qualified name for the `LCM` class).

To get the best results from Visual Studio Code, it may be necessary to first create an Eclipse project by using Eclipse.
3 changes: 3 additions & 0 deletions docs/content/contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Contributing

LCM uses the GNU LESSER GENERAL PUBLIC LICENSE. The full text may be found in the [COPYING](https://github.com/lcm-proj/lcm/blob/master/COPYING) file.
8 changes: 8 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,14 @@ sending a message to the `mailing list <http://groups.google.com/group/lcm-users
content/lua-api.md
python/index.rst

.. toctree::
:maxdepth: 1
:caption: Contributing
:glob:

content/contributing.md
content/contributing-c.md
content/contributing-java.md

Indices and tables
==================
Expand Down

0 comments on commit 5b83115

Please sign in to comment.