X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=lcm%2FREADME.md;h=159c10367337964e1dfe817a4a503362a0ab7206;hb=41275b60f7a38d0bb20df57f4e34386e7783630d;hp=65717d613d2e411a0cf1b4a1fb156f3130f4ad21;hpb=ba64ce23c5572b0de5e5596a479d9090115009e4;p=vfc%2Fgvnfm%2Fvnflcm.git

diff --git a/lcm/README.md b/lcm/README.md
index 65717d61..159c1036 100644
--- a/lcm/README.md
+++ b/lcm/README.md
@@ -13,3 +13,21 @@ See the License for the specific language governing permissions and
 limitations under the License.
 
 Micro service of vnf life cycle management.
+
+1. Code structure guide
+   ./         vnflcm project files
+   ./docker   vnflcm docker related scripts
+   ./logs     vnflcm log file
+   ./lcm      vnf life cycle management
+       ./nf      vnf life cycle API& logic
+             ./               API url and const
+             ./views          API related VNF views, each operation is a view
+             ./serializers    API related request and response parametes.
+                              Suggest related to sol003, each datatype is a file.
+                              Common datatypes are put into the common file
+             ./biz            VNF LCM mangement busyness logic files
+             ./tests          all the test case. At least each API should have a test case
+       ./jobs      vnf lcm related job
+       ./pub       common class, including database, external micro service API, utils, and config parameters.
+       ./samples   vnflcm micro service health check
+       ./swagger   auto-generate vnflcm swagger