Преглед изворни кода

doc: clean up local development doc

Samuel Padgett пре 4 година
родитељ
комит
7f00fae65a
1 измењених фајлова са 10 додато и 4 уклоњено
  1. 10 4
      README.md

+ 10 - 4
README.md

@@ -13,7 +13,8 @@ and enabled in the console operator config by a cluster administrator.
 
 [Node.js](https://nodejs.org/en/) and [yarn](https://yarnpkg.com) are required
 to build and run the example. To run OpenShift console in a container, either
-[Docker](https://www.docker.com) or [podman](https://podman.io) are required.
+[Docker](https://www.docker.com) or [podman](https://podman.io) and
+[oc](https://mirror.openshift.com/pub/) are required.
 
 ## Getting started
 
@@ -47,14 +48,19 @@ to deploy it to a cluster.
 
 ### Option 1: Local
 
+In one terminal window, run:
+
 1. `yarn install`
 2. `yarn run start`
-3. `oc login` (requires an OpenShift cluster)
-4. `yarn run start-console` (requires Docker or podman)
-5. Navigate to <http://localhost:9000/example>
+
+In another terminal window, run:
+
+1. `oc login` (requires [oc](https://mirror.openshift.com/pub/) and an OpenShift cluster)
+2. `yarn run start-console` (requires [Docker](https://www.docker.com) or [podman](https://podman.io))
 
 This will run the OpenShift console in a container connected to the cluster
 you've logged into. The plugin HTTP server runs on port 9001 with CORS enabled.
+Navigate to <http://localhost:9000/example> to see the running plugin.
 
 ### Option 2: Docker + VSCode Remote Container