[sdk] Updated README and bug comment

Bug: 338408644
Change-Id: Ieba9dc10732073d03ea944eb7f0b66406db87b24
Reviewed-on: https://fuchsia-review.googlesource.com/c/sdk-samples/getting-started/+/1050922
Reviewed-by: Jiaming Li <lijiaming@google.com>
2 files changed
tree: e08722855d26b60949e21c94acb8ff8eadd46ada
  1. manifests/
  2. scripts/
  3. src/
  4. third_party/
  5. tools/
  6. .bazelignore
  7. .bazelrc
  8. .gitignore
  9. .gitmodules
  10. AUTHORS
  11. BUILD.bazel
  12. CONTRIBUTING.md
  13. getting-started.code-workspace
  14. LICENSE
  15. MODULE.bazel
  16. MODULE.bazel.lock
  17. OWNERS
  18. PATENTS
  19. README.md
  20. shac.star
  21. shac.textproto
  22. WORKSPACE.bazel
README.md

Fuchsia samples using the Fuchsia SDK

This repository contains instructions and source code to build, package and run Fuchsia samples using only the Fuchsia SDK.

Set up and bootstrap the SDK samples repository

Clone this SDK samples repository on your host machine. This repository contains the Bazel-based Fuchsia SDK and sample components.

The tasks include:

  • Bootstrap the SDK samples repository.
  • Download the SDK toolchain to initialize the SDK environment.
  • Verify that you can run ffx commands.

Do the following:

  1. Open a terminal.

  2. In the terminal, change to your home directory:

    cd
    
  3. Clone the Fuchsia samples repository:

    git clone https://fuchsia.googlesource.com/sdk-samples/getting-started fuchsia-getting-started --recurse-submodules
    

    This git clone command creates a new directory named fuchsia-getting-started and clones the content of the SDK samples repository{:.external}.

  4. Go to the new directory:

    cd fuchsia-getting-started
    
  5. Run the bootstrap script to install Bazel and other required dependencies:

    scripts/bootstrap.sh
    
  6. Download the SDK toolchain:

    tools/bazel build @fuchsia_sdk//:fuchsia_toolchain_sdk
    

    This command may take a few minutes to download all the tools and dependencies, such as Clang{:.external} and Fuchsia IDK (which includes the ffx tool).

    When finished successfully, it prints output similar to the following:

    $ tools/bazel build @fuchsia_sdk//:fuchsia_toolchain_sdk
    ...
    INFO: Elapsed time: 25.063s, Critical Path: 0.03s
    INFO: 1 process: 1 internal.
    INFO: Build completed successfully, 1 total action
    
  7. To verify that you can use the ffx tool in your environment, run the following command:

    tools/ffx sdk version
    

    This command prints output similar to the following:

    $ tools/ffx sdk version
    20.20240513.1.1
    

    At this point, you only need to confirm that you can run ffx commands without error.

    Note: The output above shows the version 20.20240513.1.1, which indicates that this SDK was built and published on May 13, 2024.