From b9536ed802181720e9712541ad357905511bf142 Mon Sep 17 00:00:00 2001
From: RXGottlieb <36906916+RXGottlieb@users.noreply.github.com>
Date: Fri, 8 Nov 2024 10:13:04 -0500
Subject: [PATCH] Bug fixes in README (#9)

Also added storage folder.
---
 .codecov.yml                     |  1 -
 .gitignore                       |  1 -
 README.md                        | 24 ++++++++++++------------
 src/transform/storage/.gitignore |  4 ++++
 4 files changed, 16 insertions(+), 14 deletions(-)
 delete mode 100644 .codecov.yml
 create mode 100644 src/transform/storage/.gitignore

diff --git a/.codecov.yml b/.codecov.yml
deleted file mode 100644
index 959972a..0000000
--- a/.codecov.yml
+++ /dev/null
@@ -1 +0,0 @@
-comment: false
\ No newline at end of file
diff --git a/.gitignore b/.gitignore
index cdc5b8d..23dfb0b 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,3 +1,2 @@
 .vscode/
-src/transform/storage/
 Manifest.toml
\ No newline at end of file
diff --git a/README.md b/README.md
index db48eb5..1c373c8 100644
--- a/README.md
+++ b/README.md
@@ -456,13 +456,13 @@ SourceCodeMcCormick generated functions, we can make use of the massive parallel
 available using GPUs.
 
 ```julia
-using JuMP, EAGO, SourceCodeMcCormick, CUDA
+using JuMP, EAGO, SourceCodeMcCormick, Symbolics, DocStringExtensions CUDA
 
-# Import the ParBB algorithm (Note: path may vary depending on where
-# this file is in relation to SourceCodeMcCormick)
-include(joinpath(@__DIR__, "ParBB", "extension.jl"))
-include(joinpath(@__DIR__, "ParBB", "subroutines.jl"))
-include(joinpath(@__DIR__, "ParBB", "kernels.jl"))
+# Import the ParBB algorithm
+BASE_FOLDER = dirname(dirname(pathof(SourceCodeMcCormick)))
+include(joinpath(BASE_FOLDER, "examples", "ParBB", "extension.jl"))
+include(joinpath(BASE_FOLDER, "examples", "ParBB", "subroutines.jl"))
+include(joinpath(BASE_FOLDER, "examples", "ParBB", "kernels.jl"))
 
 # Weights associated with the hidden layer
 W1 = [ 0.54  -1.97  0.09  -2.14  1.01  -0.58  0.45  0.26;
@@ -595,13 +595,13 @@ implementation. The following shows how SourceCodeMcCormick's new subgradient fe
 with ParBB.
 
 ```julia
-using JuMP, EAGO, SourceCodeMcCormick, CUDA
+using JuMP, EAGO, SourceCodeMcCormick, Symbolics, DocStringExtensions, CUDA
 
-# Import the ParBB algorithm (Note: path may vary depending on where
-# this file is in relation to SourceCodeMcCormick)
-include(joinpath(@__DIR__, "ParBB", "extension.jl"))
-include(joinpath(@__DIR__, "ParBB", "subroutines.jl"))
-include(joinpath(@__DIR__, "ParBB", "kernels.jl"))
+# Import the ParBB algorithm
+BASE_FOLDER = dirname(dirname(pathof(SourceCodeMcCormick)))
+include(joinpath(BASE_FOLDER, "examples", "ParBB", "extension.jl"))
+include(joinpath(BASE_FOLDER, "examples", "ParBB", "subroutines.jl"))
+include(joinpath(BASE_FOLDER, "examples", "ParBB", "kernels.jl"))
 
 # Weights associated with the hidden layer
 W1 = [ 0.54  -1.97  0.09  -2.14  1.01  -0.58  0.45  0.26;
diff --git a/src/transform/storage/.gitignore b/src/transform/storage/.gitignore
new file mode 100644
index 0000000..86d0cb2
--- /dev/null
+++ b/src/transform/storage/.gitignore
@@ -0,0 +1,4 @@
+# Ignore everything in this directory
+*
+# Except this file
+!.gitignore
\ No newline at end of file