Skip to content

docs: fix build commands from repository root - #84

Open
jacktony2001 wants to merge 1 commit into
CluvexStudio:mainfrom
jacktony2001:docs/fix-build-working-directory
Open

docs: fix build commands from repository root#84
jacktony2001 wants to merge 1 commit into
CluvexStudio:mainfrom
jacktony2001:docs/fix-build-working-directory

Conversation

@jacktony2001

Copy link
Copy Markdown

Summary

The repository's build instructions currently omit the required aether working directory even though the root checkout has no Cargo.toml.

This PR:

  • Adds cd aether before build commands in the English and Persian README files.
  • Corrects the documented binary path to aether/target/release/aether when commands are run from the repository root.
  • Adds the same working-directory clarification to the detailed English and Persian library-build documentation.

Why

Following the previous root-level instructions from a fresh checkout leads users to invoke Cargo without a manifest. The corrected commands match the actual repository layout and the Dockerfile's existing /usr/src/app/aether working directory.

Validation

  • git diff --check passes.
  • Confirmed the only Rust manifests are under aether/ and quiche/.
  • Confirmed this PR changes documentation only.
  • A full Cargo build was not run in the validation environment because Rust/Cargo is not installed there.

Closes #83

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.

docs: build commands omit the required aether working directory

1 participant