Improve PMS API with Best Practice Suggestions
[ccsdk/oran.git] / README.md
1 ## General
2
3 This source repository contains the code for the ORAN A1 related components.
4
5 More information on the CCSDK A1 Policy Management Service can be found in the 'a1-policy-management' sub-directory. 
6
7 More information on the CCSDK A1-Adapter controller extension can be found in the 'a1-adapter' subdirectory.
8
9 See also additional information at:  
10   - https://wiki.onap.org/display/DW/O-RAN+A1+Policies+in+ONAP
11   - https://docs.onap.org/projects/onap-ccsdk-oran/en/latest/index.html
12
13 ## Prerequisits
14
15 To compile this code:
16
17 1. Make sure your local Maven settings file ($HOME/.m2/settings.xml) contains references to the ONAP repositories and OpenDaylight repositories.
18
19 2. To compile, run "mvn clean install".
20
21 ## License
22
23 Copyright (C) 2022-2023 Nordix Foundation. All rights reserved.
24 Copyright (C) 2024 OpenInfra Foundation Europe. All rights reserved.
25
26 Licensed under the Apache License, Version 2.0 (the "License");
27 you may not use this file except in compliance with the License.
28 You may obtain a copy of the License at
29
30 http://www.apache.org/licenses/LICENSE-2.0
31
32 Unless required by applicable law or agreed to in writing, software
33 distributed under the License is distributed on an "AS IS" BASIS,
34 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
35 See the License for the specific language governing permissions and
36 limitations under the License.
37
38 SPDX-License-Identifier: Apache-2.0
39
40
41