From 646f36ea0af72895c49d2dee1963e864050ce861 Mon Sep 17 00:00:00 2001 From: Daniel Silhavy Date: Wed, 9 Aug 2023 10:56:11 +0200 Subject: [PATCH] Fixes issues in the README.md (#5) * Fixes two typos in the README.md * Add missing cmake dependency * Navigate to build folder before running installation to avoid error "Install data not found. Run this command in build directory root." --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 3930d4b..be381dc 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ This library implements the service consumer end of the following service-based ### `libscpcf` - Policy Control Function (PCF) service consumer library -The Policy Control Function (PCF) is responsible for applying charging and network policy to the PDU sessions of UEs. The *Npcf_PolicyAuthorization* service API is used at refernece point N5 by an Application Function (AF) to request policy changes to the PDU session on behalf of the UE. This allows an Application Function to manipulate particular network QoS parameters for selected IP traffic flows within the PDU session. +The Policy Control Function (PCF) is responsible for applying charging and network policy to the PDU sessions of UEs. The *Npcf_PolicyAuthorization* service API is used at reference point N5 by an Application Function (AF) to request policy changes to the PDU session on behalf of the UE. This allows an Application Function to manipulate particular network QoS parameters for selected IP traffic flows within the PDU session. The `libscpcf` library allows an application to connect to a PCF and request an `AppSessionContext` which it can then use to manipulate the network routing policies for traffic passing across specific application flows within a UE's PDU Session. @@ -51,7 +51,7 @@ The PCF address can be explicitly specified at the command line if this is alrea To build and use the service consumer libraries and accompanying command line tools, you will need to install the following packages: ```bash -sudo apt install git ninja-build build-essential flex bison libsctp-dev libgnutls28-dev libgcrypt-dev libssl-dev libidn11-dev libmongoc-dev libbson-dev libyaml-dev libnghttp2-dev libmicrohttpd-dev libcurl4-gnutls-dev libnghttp2-dev libtins-dev libtalloc-dev meson +sudo apt install git ninja-build build-essential flex bison libsctp-dev libgnutls28-dev libgcrypt-dev libssl-dev libidn11-dev libmongoc-dev libbson-dev libyaml-dev libnghttp2-dev libmicrohttpd-dev libcurl4-gnutls-dev libnghttp2-dev libtins-dev libtalloc-dev meson cmake ``` ## Downloading @@ -69,7 +69,7 @@ git clone --recurse-submodules https://github.com/5G-MAG/rt-5gc-service-consumer ## Building -The build process requires a working Internet connection as project dependancies are downloaded during the build. +The build process requires a working Internet connection as project dependencies are downloaded during the build. To build the libraries and tools from the source: @@ -84,7 +84,7 @@ ninja -C build To install the built libraries and tools: ```bash -cd ~/rt-5gc-service-consumers +cd ~/rt-5gc-service-consumers/build sudo meson install --no-rebuild ```