README.txt

I. ndnQoS
===========

1. Prerequisites
---------------
For Ubuntu Linux 18.04
	sudo apt install build-essential libsqlite3-dev libboost-all-dev libssl-dev git python-setuptools castxml
For Ubuntu Linux 20.04
	sudo apt install build-essential libsqlite3-dev libboost-all-dev libssl-dev git python3-setuptools castxml

2. Code Checkout:
----------------
git clone -recursive https://github.com/nsol-nmsu/ndnQoS.git
cd ndnQoS/	// Move to ndnQoS directory

3. Check branch details (make sure you are in 'qos' branch in NDN_QoS, ndnSIM, NFD and ndn-cxx folders)
-----------------------
git branch -a	// Show all branches and the current branch with * symbol.
git remote -v	// Display git url

4. Build code
-------------
cd ns-3/	// Move to ns-3 directory
./waf configure --enable-examples	// configure with examples
./waf	// build code once

5. Pushing the code
-------------------
git branch -a	// Make sure you are in proper branch(qos) before making modifications.
git checkout <branch_name>	// To checkout to a spacific branch
git status	// In modified git directory(ndnSIM,NFD,ndn-cxx) will show modified or new file in red color
git add .	// Add all modified files to repository or select individual files instead of dot to add that file alone.
git status	// All the files added to git will change color to green. If something is not added, will remain in red color
git commit -m "Add meaningful comment summerizing the modification made"	// Code commiting locally
git push origin qos	// Pushing the code to remote branch

6.Run QoS enabled Simulation
----------------------------
cd ns-3
NS_LOG=ndn.Consumer:ndn.Producer ./waf --run=ndn-20node-power



II. Folder Structure
=====================
1. ns-3 			- Code base
2. process_result	- Python scripts for simulations and result processing.
3. thirdparty		- Thirdparty libraries used (Required to build the code without error)
4. topology			- Topology files for Monte Carlo simulations used in scenario files


III. New files (New Mexico State University)
=====================================================

1. ns-3/src/ndnSIM/NFD/daemon/fw

	ndn-priority-tx-queue.cpp
	ndn-priority-tx-queue.hpp
	ndn-qos-queue.cpp
	ndn-qos-queue.hpp
	ndn-token-bucket.cpp
	ndn-token-bucket.hpp
	qos-strategy.cpp
	qos-strategy.hpp
	TBucketDebug.cpp
	TBucketDebug.hpp

2. ns-3/src/ndnSIM/apps

	TBucketRef.cpp
	TBucketRef.hpp
	ndn-QoS-consumer.cpp
	ndn-QoS-consumer.hpp
        ndn-QoS-producer.cpp
        ndn-QoS-producer.hpp
	tokenBucketDriver.cpp
	tokenBucketDriver.hpp

IV . Documentation
==================
Documentation is available in ns-3/src/ndnSIM/docs/html/ folder.
Open index.html in browser and you will be able to find the documentation similar to ndnSIM.