search

amino-os / Amino.Run

Amino Distributed OS - Runtime Manager
Apache License 2.0
30 stars 12 forks source link

Getting Started Experience for developers wanting to try it out should be excellent #656

Open quinton-hoole opened 5 years ago

quinton-hoole commented 5 years ago

Getting Started Experience for developers wanting to try it out (i.e. download, build, deploy, run a compelling example) should be excellent.

See #654.

Detail to be filled in here. Individual issues and PR's to be linked to this issue.

prostil commented 5 years ago

This section "Onboarding Process" needs to be moved to the main read.me as of now it is part of the Getting Started doc here https://github.com/Huawei-PaaS/DCAP-Sapphire/blob/master/docs/GettingStarted.md

May be we can call it "Prerequisites to Start"

The next sections should be

  1. Setting up the dev env --- Provide write up for Mac/Win/Linux in separate sections
  2. Clone, build and test Amino core
  3. Run basic examples --- Here provide steps to run each of the example app
prostil commented 5 years ago

Some references to the repo exist in the Development guide which refer to Huawei-PaaS/DCAP-Sapphire, once we move to the new repo these docs need to be updated ASAP