Skip to content

docs: student onboarding and safer Cortex credentials packaging - #28

Merged
javiergs merged 6 commits into
mainfrom
docs/student-onboarding-security
Oct 31, 2026
Merged

javiergs merged 6 commits into
mainfrom
docs/student-onboarding-security

Conversation

@javiergs

Copy link
Copy Markdown
Owner

Summary

  • Add docs/student-quick-start.md with Java 21, EMOTIV Launcher/Virtual Brainwear, credential setup, first example, and independent Maven project instructions.
  • Add docs/examples.md describing five runnable streams, commands, expected observations, licensing caveats, and small student exercises.
  • Link the guides from README, remove extra blank lines, clarify credentials, and explain the two complementary CI workflows.
  • Configure maven-jar-plugin to exclude cortex4j.properties from JARs, while keeping local resource loading functional for exec:java. Important: local target/classes may still contain credentials; do not distribute build directories.
  • Set explicit read-only contents: read permission in the isolated Maven Central dependency workflow.

Validation

  • Confirm mvn clean verify passes with Java 21.
  • Confirm jar tf target/cortex4j-getting-started-1.0.jar does not list cortex4j.properties when a local credentials file is present.
  • If possible, confirm DeviceExample still 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.

@javiergs
javiergs merged commit 7461d37 into main Oct 31, 2026
2 checks passed
@javiergs
javiergs deleted the docs/student-onboarding-security branch October 31, 2026 04:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant