diff --git a/.vscode/settings.json b/.vscode/settings.json index af13e3a..5dc48a0 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -1,5 +1,6 @@ { "files.associations": { "cstdint": "cpp" - } + }, + "editor.rulers": [80, 120] } \ No newline at end of file diff --git a/AUTHORS b/AUTHORS new file mode 100644 index 0000000..ded897b --- /dev/null +++ b/AUTHORS @@ -0,0 +1,7 @@ +The Harriman-Peikoff Project +============================ + +Authors +------- + +- Kofi Doku Atuah diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..4cc392f --- /dev/null +++ b/COPYING @@ -0,0 +1,69 @@ +The Harriman-Peikoff Project License Agreement + +This software and associated documentation files (the "Software") are the +proprietary and confidential information of Kofi Doku Atuah ("Licensor"). +By using, copying, modifying, or distributing the Software, you agree to be +bound by the terms of this License Agreement. + +1. License Grant + Licensor grants you a limited, non-exclusive, non-transferable, and + revocable license to use the Software solely for your internal business + purposes, subject to the terms and conditions of this License Agreement. + +2. Restrictions + You shall not: + a. Copy, modify, or create derivative works of the Software; + b. Distribute, transfer, sublicense, lease, lend, or rent the Software to + any third party; + c. Reverse engineer, decompile, or disassemble the Software; + d. Remove or alter any proprietary notices or labels on the Software. + +3. Ownership + Licensor retains all right, title, and interest in and to the Software, + including all intellectual property rights therein. This License Agreement + does not grant you any ownership rights in the Software. + +4. Termination + This License Agreement is effective until terminated. Licensor may terminate + this License Agreement at any time without notice if you breach any term of + this License Agreement. Upon termination, you shall cease all use of the + Software and destroy all copies of the Software in your possession or + control. + +5. Disclaimer of Warranties + The Software is provided "as is" without warranty of any kind, express or + implied, including but not limited to the warranties of merchantability, + fitness for a particular purpose, and non-infringement. Licensor does not + warrant that the Software will meet your requirements or that the operation + of the Software will be uninterrupted or error-free. + +6. Limitation of Liability + In no event shall Licensor be liable for any damages whatsoever (including, + without limitation, damages for loss of business profits, business + interruption, loss of business information, or other pecuniary loss) arising + out of the use or inability to use the Software, even if Licensor has been + advised of the possibility of such damages. + +7. Governing Law + This License Agreement shall be governed by and construed in accordance with + the laws of the State of Delaware, USA. If the laws of Delaware, USA, are + not applicable, then the laws of Switzerland shall apply. If neither the + laws of Delaware, USA, nor Switzerland are applicable, then the laws of + the jurisdiction chosen by the Licensor shall apply, without regard to its + conflict of law principles. + +8. Entire Agreement + This License Agreement constitutes the entire agreement between you and + Licensor with respect to the Software and supersedes all prior or + contemporaneous understandings or agreements, written or oral, regarding + such subject matter. + +If you have any questions about this License Agreement, please contact: + +Kofi Doku Atuah: + Email: + GitHub: + LinkedIn: + +Kofi Doku Atuah +2024-Nov-21 diff --git a/INSTALL b/INSTALL new file mode 100644 index 0000000..62bc764 --- /dev/null +++ b/INSTALL @@ -0,0 +1,50 @@ +The Harriman-Peikoff Project Installation Instructions +====================================================== + +1. Prerequisites +---------------- +Ensure you have the following tools installed on your system: +- GNU Autoconf +- GNU Automake +- GNU Make +- A C++ compiler (e.g., GCC) + +2. Building the Project +------------------------ +Open a terminal and navigate to the root directory of the project. Then run the +following commands: + +```sh +./autogen.sh +./configure +make +``` + +3. Installing the Project +-------------------------- +To install the project, run the following command with superuser privileges: + +```sh +sudo make install +``` + +4. Running the Project +----------------------- +After installation, you can run the project by executing: + +```sh +harikoff +``` + +5. Uninstalling the Project +---------------------------- +To uninstall the project, navigate to the root directory of the project and run: + +```sh +sudo make uninstall +``` + +6. Troubleshooting +------------------- +If you encounter any issues during installation or usage, please refer to the +`README.md` file or contact the project maintainers for support. \ No newline at end of file diff --git a/README b/README index e69de29..a6be072 100644 --- a/README +++ b/README @@ -0,0 +1,5 @@ +# The Harriman-Peikoff Project + +Wouldn't you like to know what this project is and does? Well, it's a secret! +But you can find out by reading the code. Or you could just ask me. Or you +could wait until I release it. But that's no fun. diff --git a/configure.ac b/configure.ac index 4bee969..4c55672 100644 --- a/configure.ac +++ b/configure.ac @@ -1,8 +1,5 @@ AC_INIT([The Harriman-Peikoff Project],[0.00],[latentprion@gmail.com],[harikoff],[github.com/latentprion/harikoff]) -AC_DEFUN([TEST_IS_NUMBER], [`echo $1 | grep -c '^[0-9]\+$'` -gt 0]) -AC_DEFUN([TEST_NOT_NUMBER], [`echo $1 | grep -c '^[0-9]\+$'` -eq 0]) - # Safety checks in case user overwritten --srcdir AC_CONFIG_SRCDIR(core/main.cpp) @@ -10,30 +7,15 @@ AC_CONFIG_SRCDIR(core/main.cpp) # in this dir (build-aux) AC_CONFIG_AUX_DIR([build-aux]) -# Init automake, and specify this program use relaxed structures. -# i.e. this program doesn't follow the gnu coding standards, and doesn't have -# ChangeLog, COPYING, AUTHORS, INSTALL, README etc. files. -AM_INIT_AUTOMAKE([-Wall -Werror foreign]) +# Init automake, and specify this program follows the gnu coding standards. +AM_INIT_AUTOMAKE([-Wall -Werror]) + +# Add standard GNU files +AC_CONFIG_FILES([ChangeLog COPYING AUTHORS INSTALL README]) AC_PROG_CC AC_PROG_CXX -# AC_CHECK_HEADERS([stdio.h]) - -# AC_MSG_ERROR([You must set the number of sensors with num_sensors], 1)) -AS_IF([test "X$num_sensors" = "X"], - AC_MSG_ERROR([You must set num_sensors])) -AS_IF([test `echo $num_sensors | grep -c '^[0-9]\+$'` -gt 0], - AC_MSG_ERROR([num_sensors must be an integer])) -AS_IF([test $num_sensors -lt 1], - AC_MSG_ERROR([Harikoff needs at least 1 sensor])) - -num_sensors_desc="Number of sensors harikoff has direct purview over" -AC_ARG_VAR([num_sensors], - AS_HELP_STRING([num_sensors=],[$num_sensors_desc])) - -AC_DEFINE_UNQUOTED([CONFIG_NUM_SENSORS], [$num_sensors], [$num_sensors_desc]) - AC_CONFIG_HEADERS([config.h]) AC_CONFIG_FILES([Makefile core/Makefile])