update project

Author: gavinlyonsrepo

.gitignore

@@ -1,6 +1,9 @@
 *.depend
 *.layout
 *.cbp
+lib_finder.script
 obj/
 bin/
-lib_finder.script
+Bin/
+Build/
+stuff/

LICENSE.md

@@ -0,0 +1,19 @@
+Copyright (c) <2018> <Gavin Lyons>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+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 NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Makefile

@@ -1,26 +1,92 @@
-# --- constants
+#==============================
+# Gavin Lyons 12-2023
+# Make file to build Fractal Creator Program
+# URL:: https://github.com/gavinlyonsrepo/Fractal_creator
+# Run make help for options
+#==============================
+
+SRC=src/
 CC=g++
-CFLAGS=-Wall -g -c
-LDFLAGS=-Wall -g -L /usr/lib/x86_64-linux-gnu 
-SOURCES = $(wildcard ./src/*.cpp)
-OBJECTS = $(SOURCES:.cpp=.o)
-BIN=./bin
-INCLUDES=./include
-TARGET=$(BIN)/fcsim
-
-
-# --- Target of build process
-all:	$(TARGET) clean
-
-$(TARGET):	$(OBJECTS)
-	$(CC) -o $(TARGET) $(OBJECTS) $(LDFLAGS)
-
-# Make an .o from a .cpp
-%.o: %.cpp
-	$(CC) $(CFLAGS) -o $@ -c $< -iquote $(INCLUDES)
-	
-	
-# --- Cleanup
-#.PHONY: clean
+LDFLAGS= -L /usr/lib/x86_64-linux-gnu 
+CFLAGS = -std=c++2a -Iinclude/ -c -Wall  -Wextra
+MD=mkdir
+BUILD=Build
+SRCS = $(wildcard $(SRC)/*.cpp)
+OBJS = $(patsubst $(SRC)/%.cpp,  $(BUILD)/%.o, $(SRCS))
+BIN=./Bin
+EXENAME=fcsim
+TARGET=$(BIN)/$(EXENAME)
+PREFIX=/usr/local/bin
+
+# The --no-print-directory option of make tells make not to print the message about entering 
+# and leaving the working directory. 
+MAKEFLAGS += --no-print-directory
+
+# Main task,  makes build directory, updates your objects, builds your executable
+.PHONY: all
+all: clean build
+
+
+# Task producing target from built files
+$(TARGET): $(OBJS) $(BUILD)
+	@echo 'MAKE EXE FILE'
+	$(CXX)  $(OBJS) -o $@ $(LDFLAGS)
+	@echo '[DONE!]'
+
+# Compile all cpp files
+$(BUILD)/%.o :  $(SRC)/%.cpp   $(BUILD) 
+	@echo 'MAKE OBJECT FILE'
+	$(CXX) $(CFLAGS) $< -o  $@ 
+
+
+# Build task
+.PHONY:	build
+build:
+	@echo 
+	@echo '[BUILDING:!]'
+	@echo  $(SRC)
+	$(MD) -vp $(BIN)
+	$(MD) -vp $(BUILD)
+	$(MAKE) $(TARGET)
+	@echo '***************'
+
+# Run task
+.PHONY: run
+run:
+	$(TARGET)
+
+# Clean task :: removes obj and executbale
+.PHONY: clean
 clean:
-	rm -vf $(OBJECTS)
+	@echo 
+	@echo '[CLEANUP!]'
+	rm -rvf $(BUILD) $(BIN)
+	@echo '[DONE!]'
+
+
+# Help task :: explains the options
+.PHONY: help
+help:
+	@echo '[HELP!]'
+	@echo "make           - Cleans + builds project"
+	@echo "make clean     - Cleans : Removes object file folder and executable"
+	@echo "make build     - Complies and Builds project"
+	@echo "make run       - Runs exe"
+	@echo "make install   - Installs exe, may need sudo"
+	@echo "make uninstall - Uninstalls exe, may need sudo"
+	@echo "make help      - Prints help message"
+	@echo '***************'
+
+#install exe
+.PHONY: install
+install:
+	@echo "[INSTALL EXE]"
+	cp -v $(TARGET) $(PREFIX)/$(EXENAME)
+	@echo "*****************"
+
+# Uninstall the exe
+.PHONY: uninstall
+uninstall:
+	@echo "[UNINSTALL EXE]"
+	@rm -vf $(PREFIX)/$(EXENAME)
+	@echo "******************"

README.md

@@ -6,7 +6,7 @@ Overview
 
 * Description: 
 Fractal Creator. This Demo program is written in C++. 
-This project creates a bitmap file (800x600) and 
+This project creates a bitmap file  and 
 then applies two magnification functions 
 to a sector of that file. The bitmap is a graphic image.
 The graphic image is a fractal created by the Mandelbrot Set.
@@ -15,23 +15,43 @@ and simulate naturally occurring objects. Fractals can also be nearly the
 same at different levels. 
 
 * Author: Gavin Lyons
-* Credits: www.caveofprogramming.com  
+* Credits: Based on code from www.caveofprogramming.com  
 
 Installation
 -----------------------------------------------
 For local install on Linux based OS 
 
-* Download latest release
+* Download github directory
 * extract tarball
-* cd into same path as Makefile
-* run make 
-* copy exe at .bin/fcsim to where you want it
+* 'cd' into same path as Makefile
+* run 'make'  to build
+* Exe file made at ./Bin/fcsim 
+* run 'make help' for all options. 
+
+Usage
+------------------------------------------
+
+```
+fcsim  [arguments]
+fcsim 800 600 0.1 2
+```
+Arguments list
+
+| Number | Name | Default value | Notes  | 
+| -------- | ----------- | ----------- | ----------- |
+| 1 | width Resolution | 800 | width of bmp file | 
+| 2 | height Resolution| 600 | height of bmp file | 
+| 3 | zoom Scale |  0.1 | smaller the number higher the zoom | 
+| 4 | number of Zooms | 0 | 0, 1 or 2| 
 
 Output 
+
 -------------------------------------
 Bitmap Output files are outputted to:-
 where RRRR is random number.
 
 ```sh
 /tmp/FractalRRRR.BMP
 ```
+
+![Ss](https://github.com/gavinlyonsrepo/Fractal_creator/blob/master/documentation/screenshots/Fractal_before_zoom.png)