diff --git a/README.md b/README.md index c9a4f7aa0bdab7868e065bff0d84adf3d9df6212..77fd6e41724e64ba923db6918d7b166fe0c69874 100644 --- a/README.md +++ b/README.md @@ -31,9 +31,9 @@ In the Ops part of the DevSecOps lifecycle, PIACERE also presents several key in ## Repository structure The Public repository of PIACERE project is organized as follows: -- **[/agents]**: contain the monitoring agents that need to be deployed along with the IaC to monitor the infrastructure +- [/agents]: contain the monitoring agents that need to be deployed along with the IaC to monitor the infrastructure - [/demos]: different demos that can serve as a basic examples of using PIACERE -- [/The Platform]: is divided in many repositories where the several [components](#Components) of the PIACERE framework can be found +- **[/The Platform]**: is divided in many repositories where the several [components](#Components) of the PIACERE framework can be found Three branches **Y1**, **Y2**, **Y3** gather the versions delivered in the three main milestones of the project (at M12, M24 and M30). The **main** branch stores the final version of the components, as some development and code fixes could continue until the end of the 36-months long project. @@ -64,18 +64,21 @@ Diagram of the PIACERE framework: ## Acknowledgement This project has received funding from the European Union’s Horizon 2020 research and innovation programme under Grant Agreement No. 101000162.  -### ===== Uniform approach for component repos ===== (TO BE DELETED) -- Include a README file with the following sections (see aprox. model in [iac-scan-runner/README.md](https://git.code.tecnalia.com/piacere/public/the-platform/iac-scan-runner/-/blob/main/README.md), Thx @XLAB! :-)) +# +*** Uniform approach for component repos *** (TO BE DELETED) +# + +- README: Include a README file with the following sections (see aprox. model in [iac-scan-runner/README.md](https://git.code.tecnalia.com/piacere/public/the-platform/iac-scan-runner/-/blob/main/README.md), Thx @XLAB! :-)) - Description of the component - Installation - Documentation (point to) - License - Contact - Acknowledgement -- Branches in each repository: - - **y1**, **y2**, **y3** (M30-jun code) - - **main** (default, from now on) - 1. Create **main** if not exist in your repo (_Code>Branches>New branch_) +- BRANCHES: Branches in each repository: + - **y1**, **y2** and **y3** (M30-jun code), with the respective code + - **main** (default branch, versions from now on) + 1. If not exist, create **main** in your repo (_Code>Branches>New branch_) 2. Make it the "default" branch (_Settings>Repository>Branch defaults_)