o3de-atom-sampleviewer icon indicating copy to clipboard operation
o3de-atom-sampleviewer copied to clipboard

README.md does not contain build instructions

Open LB-ArturZieba opened this issue 1 year ago • 0 comments

Describe the bug Atom Sample Viewer README.md (https://github.com/o3de/o3de-atom-sampleviewer/blob/development/README.md) does not contain build instructions, only instructions on cloning are listed.

There were build instructions listed on older version of o3de.org documentation: https://version-2205--o3deorg.netlify.app/docs/atom-guide/setup-atom-projects/, however that page does not exist anymore in the current documentation (https://www.o3de.org/docs/atom-guide/setup-atom-projects/). This is most likely due to https://github.com/o3de/o3de.org/issues/687 where it is mentioned that documentation on AtomSampleViewer will be kept in the repository's README.md file (https://github.com/o3de/o3de.org/issues/687#issuecomment-1414525513).

Steps to reproduce

  1. View https://github.com/o3de/o3de-atom-sampleviewer/blob/development/README.md.

Expected behavior There is an instruction on building the AtomSampleViewer project provided.

Actual behavior There is only an instruction on cloning the project provided.

Found in Branch development (de5519a)

Commit ID from o3de/o3de-atom-sampleviewer Repository de5519af892fcf43ca37af43e45cfeb037b4e05a

LB-ArturZieba avatar May 25 '23 12:05 LB-ArturZieba