Repository navigation
docs: student onboarding and safer Cortex credentials packaging - #28
Merged
Merged
Conversation
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
docs/student-quick-start.mdwith Java 21, EMOTIV Launcher/Virtual Brainwear, credential setup, first example, and independent Maven project instructions.docs/examples.mddescribing five runnable streams, commands, expected observations, licensing caveats, and small student exercises.maven-jar-pluginto excludecortex4j.propertiesfrom JARs, while keeping local resource loading functional forexec:java. Important: localtarget/classesmay still contain credentials; do not distribute build directories.contents: readpermission in the isolated Maven Central dependency workflow.Validation
mvn clean verifypasses with Java 21.jar tf target/cortex4j-getting-started-1.0.jardoes not listcortex4j.propertieswhen a local credentials file is present.DeviceExamplestill reads local credentials and connects to Launcher. Live device testing is not performed in CI.No change to
com.javiergs:cortex4j:0.2.0, branch protection, or underlying library source.