-
Notifications
You must be signed in to change notification settings - Fork 701
Add README files for some subprojects and update various other docs #8640
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
Open
Gold856
wants to merge
6
commits into
wpilibsuite:2027
Choose a base branch
from
Gold856:update-and-add-readmes
base: 2027
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
bdb455e
Add README files for some subprojects and update various other docs
Gold856 9b20c30
[skip ci] Adjust design philosophy on throwing
Gold856 db63bc3
Address review
Gold856 2928897
[skip ci] Update CONTRIBUTING.md
Gold856 fc2ed34
Update Python stuff
Gold856 bc61a56
Update CONTRIBUTING.md
Gold856 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -21,7 +21,7 @@ Example: | |
| org.wpilib.wpilibj:wpilibj-java:version | ||
| ``` | ||
|
|
||
| The second types are native artifacts. These are usually published as `zip` files. The `-sources` and `-headers` classifiers contain the sources and headers respectively for the library. Each artifact also contains a classifier for each platform we publish. This platform is in the format `{os}{arch}`. The full list of supported platforms can be found in [native-utils](https://github.com/wpilibsuite/native-utils/blob/main/src/main/java/edu/wpi/first/nativeutils/WPINativeUtilsExtension.java#L94). If the library is built statically, it will have `static` appended to the classifier. Additionally, if the library was built in debug mode, `debug` will be appended to the classifier. The platform artifact only contains the binaries for a specific platform. Note that the binary artifacts never contain the headers, you always need the `-headers` classifier to get those. | ||
| The second types are native artifacts. These are usually published as `zip` files. The `-sources` and `-headers` classifiers contain the sources and headers respectively for the library. Each artifact also contains a classifier for each platform we publish. This platform is in the format `{os}{arch}`. The full list of supported platforms can be found in [native-utils in the Platforms nested class](https://github.com/wpilibsuite/native-utils/blob/main/src/main/java/org/wpilib/nativeutils/WPINativeUtilsExtension.java). If the library is built statically, it will have `static` appended to the classifier. Additionally, if the library was built in debug mode, `debug` will be appended to the classifier. The platform artifact only contains the binaries for a specific platform. Note that the binary artifacts never contain the headers, you always need the `-headers` classifier to get those. | ||
|
|
||
| If the library is Java and C++ and has a JNI component, the native artifact will have a shared library containing JNI entrypoints alongside the C++ shared library. This JNI shared library will have a `jni` suffix in the file name. | ||
|
|
||
|
|
@@ -38,7 +38,7 @@ This repository provides the following artifacts. Below each artifact is its dep | |
|
|
||
| For C++, if building with static dependencies, the listed order should be the link order in your linker. | ||
|
|
||
| All artifacts are based at `org.wpilib.halsim.artifactname` in the repository. | ||
| All artifacts are based at `org.wpilib.artifactname` in the repository. | ||
|
|
||
| * wpiutil | ||
|
|
||
|
|
@@ -52,32 +52,33 @@ All artifacts are based at `org.wpilib.halsim.artifactname` in the repository. | |
| * wpiutil | ||
|
|
||
| * ntcore | ||
| * wpiutil | ||
| * wpinet | ||
| * wpiutil | ||
|
|
||
| * glass/libglass | ||
| * wpiutil | ||
| * wpimath | ||
| * wpigui | ||
| * wpimath | ||
| * wpiutil | ||
|
|
||
| * glass/libglassnt | ||
| * wpiutil | ||
| * wpinet | ||
| * wpigui | ||
| * ntcore | ||
| * wpinet | ||
| * wpimath | ||
| * wpigui | ||
| * wpiutil | ||
|
|
||
| * hal | ||
| * ntcore | ||
| * wpiutil | ||
|
|
||
| * halsim | ||
| * wpiutil | ||
| * wpinet | ||
| * libglassnt | ||
| * libglass | ||
|
Gold856 marked this conversation as resolved.
|
||
| * ntcore | ||
| * wpimath | ||
| * wpigui | ||
|
Gold856 marked this conversation as resolved.
|
||
| * libglass | ||
| * libglassnt | ||
| * wpinet | ||
| * wpiutil | ||
|
|
||
| * cscore | ||
| * opencv | ||
|
|
@@ -126,12 +127,16 @@ All artifacts are based at `org.wpilib.halsim.artifactname` in the repository. | |
|
|
||
| ### Third Party Artifacts | ||
|
|
||
| This repository provides the builds of the following third party software. | ||
| This repository provides the builds of the following third party software: | ||
|
|
||
| All artifacts are based at `org.wpilib.thirdparty.frcYEAR` in the repository. | ||
|
|
||
| * apriltaglib | ||
| * googletest | ||
| * imgui | ||
| * opencv | ||
| * libssh | ||
|
|
||
| Other software can be found in their corresponding GitHub repositories: | ||
|
|
||
| * ceres: https://github.com/wpilibsuite/thirdparty-ceres | ||
| * gtsam: https://github.com/wpilibsuite/thirdparty-gtsam | ||
| * opencv: https://github.com/wpilibsuite/thirdparty-opencv | ||
| * libssh: https://github.com/wpilibsuite/thirdparty-libssh | ||
|
|
||
| All artifacts are based at `org.wpilib.thirdparty.frcYEAR` in the repository. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Not completely true yet, since the thirdparty repos haven't been updated yet. |
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.