diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..567609b --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +build/ diff --git a/README.md b/README.md index d37183b..44fad64 100644 --- a/README.md +++ b/README.md @@ -35,16 +35,40 @@ We look forward to your support! --- -Below are original instructions to help set this up (by Sergio). +# How to build + +* download and install `landscape2` command line tool , refer to https://github.com/cncf/landscape2 + +* build local landscape with below commands (`build` as output directory) + ``` + cd cnai-landscape -- The `main` branch contains the output of the `landscape2 new` command. -- The `build` branch contains the output of the `landscape2 build` command, which is served by GitHub Pages at . -- The [build workflow](https://github.com/rx-m/cnai-landscape/blob/main/.github/workflows/build.yml) builds the landscape and pushes the result to the `build` branch on every push to the `main` branch. + landscape2 build \ + --data-file data.yml \ + --settings-file settings.yml \ + --guide-file guide.yml \ + --logos-path logos \ + --output-dir build + ``` -Also modified: +* serve the updated landscape website locally + ``` + landscape2 serve --landscape-dir build + ``` -``` -# base_path: / -# -base_path: /cnai-landscape -``` \ No newline at end of file +* use your browser as prompt, it may be like `http://127.0.0.1:8000/cnai-landscape` + + +Below are original instructions to help set this up (by Sergio). +> +>- The `main` branch contains the output of the `landscape2 new` command. +>- The `build` branch contains the output of the `landscape2 build` command, which is served by GitHub Pages at . +>- The [build workflow](https://github.com/rx-m/cnai-landscape/blob/main/.github/workflows/build.yml) builds the landscape and pushes the result to the `build` branch on every push to the `main` branch. +> +>Also modified: +> +>``` +># base_path: / +># +>base_path: /cnai-landscape +>```