diff --git a/LICENSE b/LICENSE index c9634a4..ae3132f 100644 --- a/LICENSE +++ b/LICENSE @@ -58,7 +58,7 @@ APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. -Copyright 2024 Jackrabbit-Labs-LLC +Copyright 2024 Jackrabbit-Founders-LLC Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. diff --git a/Makefile b/Makefile index 9fe0756..4e59815 100644 --- a/Makefile +++ b/Makefile @@ -13,10 +13,10 @@ # ****************************************************************************** CC=gcc -CFLAGS= -g3 -O0 -Wall -Wextra -MACROS= -INCLUDE_DIR=/usr/local/include -LIB_DIR=/usr/local/lib +CFLAGS?= -g3 -O0 -Wall -Wextra +MACROS?= +INCLUDE_DIR?=/usr/local/include +LIB_DIR?=/usr/local/lib INCLUDE_PATH=-I $(INCLUDE_DIR) LIB_PATH=-L $(LIB_DIR) LIBS=-l arrayutils @@ -43,7 +43,11 @@ install: lib$(TARGET).a sudo cp lib$(TARGET).a $(LIB_DIR)/ sudo cp main.h $(INCLUDE_DIR)/$(TARGET).h -.PHONY: all clean doc install +uninstall: + sudo rm $(LIB_DIR)/lib$(TARGET).a + sudo rm $(INCLUDE_DIR)/$(TARGET).h + +.PHONY: all clean doc install uninstall # Variables # $^ Will expand to be all the sensitivity list diff --git a/README.md b/README.md index 354e859..f17b817 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,51 @@ -# PCI_Utils_release +# Overview + +This is a C library that implements a set of utility functions related to PCI +config space operations. + +# Supported Operating System Versions + +- Ubuntu 23.10 +- Fedora 38, 39 + +# Building + +1. Install OS libraries + +Install the following build packages to compile the software on the following +operating systems. + +**Ubuntu:** + +```bash +apt install build-essential libpci-dev +``` + +**Fedora:** + +```bash +``` + +2. Build Dependencies + +This library is dependent upon the following projects. + +- [array_utils](https://github.com/JackrabbitLabs/array_utils) + +For each of these repositories, in the order listed, clone and execute: + +```bash +make install +``` + +This will install a library (.a) and header file to the standard os location +(e.g. /usr/local/include, /usr/local/lib) + +3. Build + +After building the required dependencies run: + +```bash +make +```