summaryrefslogtreecommitdiff
path: root/docs/getting_started_quickly.md
diff options
context:
space:
mode:
authorSean Abraham <seanabraham@chromium.org>2021-03-01 15:13:48 -0700
committerSean Abraham <seanabraham@chromium.org>2021-03-01 22:59:54 +0000
commit1e800ac838504c0d2950c7aa90cdfe7bde251545 (patch)
tree64706ca3d77a1452ac653d40fb71e6ae9d6a34bc /docs/getting_started_quickly.md
parentef6a915de0a2b65c18c03074b66717d597675162 (diff)
downloadchrome-ec-master.tar.gz
docs: point md files in master to main/HEADmaster
Master md files are out of date. Point to main branch in case someone lands in master branch from an old link. BUG=b:180952272,b:180921286 BRANCH=None TEST=Preview changes with gerrit Exempt-From-Owner-Approval: fixing docs Change-Id: I6583b6c7fc21248eb49a6cd71e077fbdb5de2435 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2727846 Reviewed-by: Sean Abraham <seanabraham@chromium.org> Reviewed-by: Rob Barnes <robbarnes@google.com> Auto-Submit: Sean Abraham <seanabraham@chromium.org> Tested-by: Sean Abraham <seanabraham@chromium.org>
Diffstat (limited to 'docs/getting_started_quickly.md')
-rw-r--r--docs/getting_started_quickly.md132
1 files changed, 4 insertions, 128 deletions
diff --git a/docs/getting_started_quickly.md b/docs/getting_started_quickly.md
index 9b22dc64c7..3e9aafd06e 100644
--- a/docs/getting_started_quickly.md
+++ b/docs/getting_started_quickly.md
@@ -1,129 +1,5 @@
-# Get Started Building EC Images (Quickly)
+*** note
+**Warning: This document is old & has moved. Please update any links:**<br>
+https://chromium.googlesource.com/chromiumos/platform/ec/+/HEAD/docs/getting_started_quickly.md
+***
-[TOC]
-
-The
-[Chromium OS Developer Guide](https://chromium.googlesource.com/chromiumos/docs/+/master/developer_guide.md)
-and [README](../README.md) walk through the steps needed to fetch and build
-Chromium OS source. These steps can be followed to retrieve and build EC source
-as well. On the other hand, if your sole interest is building an EC image, the
-general developer guide contains some extra unneeded steps.
-
-The fastest possible way to build an EC image is to skip the Chromium OS chroot
-install entirely. The following steps have been tested on an Ubuntu 15.10 (Wily
-Werewolf) 64-bit host machine. Other distros / versions may be used, but
-toolchain incompatibilities may require extra debug.
-
-## Building
-
-1. Install build / dev tools:
-
- ```bash
- sudo apt-get install git libftdi-dev libusb-dev libncurses5-dev gcc-arm-none-eabi
- ```
-
-1. Sync the cros-ec git repo:
-
- ```bash
- git clone https://chromium.googlesource.com/chromiumos/platform/ec
- ```
-
-1. Build your EC image:
-
- ```bash
- HOSTCC=x86_64-linux-gnu-gcc make BOARD=$board
- ```
-
-## External Dependencies
-
-Most boards are buildable, but some will fail due to dependencies on external
-binaries (such as [`futility`](#building-futility)). Also, some related tools
-(such as `flash_ec` and `servod`) must be run from the Chromium OS chroot. Here
-is a set of steps to setup a minimal development environment to build EC images
-from the Chromium OS chroot:
-
-1. Create a folder for your chroot:
-
- ```bash
- mkdir cros-src; cd cros-src
- ```
-
-1. Run
-
- ```bash
- repo init -u https://chromium.googlesource.com/chromiumos/manifest.git --repo-url https://chromium.googlesource.com/external/repo.git -g minilayout
- ```
-
-1. Edit `.repo/manifest.xml`, and add `groups="minilayout"` to the platform/ec
- project, so the line becomes:
-
- ```
- <project path="src/platform/ec" name="chromiumos/platform/ec" groups="minilayout" />
- ```
-
-1. Run `repo sync`:
-
- ```bash
- repo sync -j <number of cores on your workstatsion>
- ```
-
-1. Enter the chroot and enter your password for `sudo` if prompted:
-
- ```bash
- ./chromite/bin/cros_sdk
- ```
-
-1. Set up your board:
-
- ```bash
- ./setup_board --board=$BOARD
- ```
-
- (ex. `./setup_board --board=glados`)
-
-1. Build EC:
-
- ```bash
- ./build_packages --board=$BOARD chromeos-ec
- ```
-
-1. Now, EC images for any board can be built with:
-
- ```bash
- cd ~/trunk/src/platform/ec; make BOARD=$board -j
- ```
-
-## Building `futility` outside the chroot {#building-futility}
-
-If you want to build the `futility` host tool outside the normal Chrome OS
-chroot self-contained environment, you can try the following
-
-1. Install futility build dependencies:
-
- ```bash
- sudo apt-get install uuid-dev liblzma-dev libyaml-dev libssl-dev
- ```
-
-1. Get the vboot reference sources:
-
- ```bash
- git clone https://chromium.googlesource.com/chromiumos/platform/vboot_reference
- ```
-
-1. Build it:
-
- ```bash
- cd vboot_reference ; make
- ```
-
-1. Install it in `/usr/local/bin`:
-
- ```bash
- sudo make install
- ```
-
-1. Add `/usr/local/bin` to your default `PATH`:
-
- ```bash
- export PATH="${PATH}:/usr/local/bin"
- ```