commit | 0f7e41aac3ef318d3799e21aac1c111b01c47e23 | [log] [tgz] |
---|---|---|
author | Jason Campbell <jasoncampbell@google.com> | Thu Apr 09 22:39:08 2020 +0000 |
committer | CQ bot account: commit-bot@chromium.org <commit-bot@chromium.org> | Thu Apr 09 22:39:08 2020 +0000 |
tree | 23b7d1ff98f792618f2099a7983d98a123859980 | |
parent | f797f8f45bc65d6a5301cb660ea21990e1fd3c5e [diff] |
[README] update README.md Adds some details about the repo and instructions/links for building. Fixed: 49625 Change-Id: I924efecd52ab048d82917439d7ff0dc3a42a7047 Reviewed-on: https://fuchsia-review.googlesource.com/c/experiences/+/378684 Reviewed-by: Gary Miguel <garymm@google.com> Commit-Queue: Gary Miguel <garymm@google.com>
This is a companion repository to Fuchsia and contains code that either implements or supports user facing code for the Fuchsia platform. The code provides a majority of the user interface for the Workstation product as well as a small set of examples, tests, and benchmarks.
This repository is a “source petal” included in the Fuchsia Platform Source Tree (FPST) checkout. Code in this repository must be built with Fuchsia in order to be functional, see (the guide)[https://fuchsia.dev/fuchsia-src/development/source_code] for instructions on getting the source.
Hardware support should be considered experimental. However, NUC's and Pixelbooks are known to work best. For details on hardware setup see: (Install Fuchsia on a Device)[https://fuchsia.dev/fuchsia-src/development/hardware/paving]
Once you have functional checkout you can (configure a build)[https://fuchsia.dev/fuchsia-src/development/build/fx#configure-a-build] targeting Workstation:
fx set workstation.<board> # For options run: `fx list-boards` fx build
See Fuchsia's (build and pave instructions)[https://fuchsia.dev/fuchsia-src/development/build/build_and_pave_quickstart] for detailed instructions.
Once built, standard Fuchsia workflows for paving, running code, and testing apply. See: (fx workflows)[https://fuchsia.dev/fuchsia-src/development/build/fx] for detailed instructions.