From a66bf0e4e6d02984965e629558554620ad3c8701 Mon Sep 17 00:00:00 2001 From: Kenny Armstrong Date: Mon, 15 Jul 2019 09:05:11 -0400 Subject: [PATCH 1/5] updated build instructions in the README, and added a Makefile for the project --- Makefile | 5 +++++ README.md | 30 ++++++++++++++++++++++++++---- README.md~ | 14 ++++++++++++++ 3 files changed, 45 insertions(+), 4 deletions(-) create mode 100644 Makefile create mode 100644 README.md~ diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..360fcf1 --- /dev/null +++ b/Makefile @@ -0,0 +1,5 @@ +CC = g++ +CFLAGS = -Wall + +hi-there: src/hi-there.cpp + $(CC) $(CFLAGS) -o hi-there src/hi-there.cpp diff --git a/README.md b/README.md index 78090a5..fc6c9c2 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,35 @@ README ====== -A simple readme file to toss into our project. +A simple application that does nothing useful except to practice with source code. -To compile the code, run: +You will need to have the GNU C++ compiler installed on your system. -`g++ -o build/hi-there src/hi-there.cpp` +* On Debian/Ubuntu, run: -###Note: +``` +sudo apt install build-essential +``` + +* On CentOS/Red Hat Enterprise Linux/Fedora, run: + +``` +sudo yum group install "Development Tools" +``` + +To build the program, run: + +``` +make +``` + +To run the program, execute: + +``` +./hi-there +``` + +### Note: No pull requests will be accepted for this repository, as it is meant to be used for demonstration purposes only. You are free to create a pull request to try it out, but no outside code will be merged into this project. It is highly recommended that you fork this project on GitHub so that you have full admin access to your own fork. This way you can practice with pushes and pull requests to see how they are done. diff --git a/README.md~ b/README.md~ new file mode 100644 index 0000000..f1cd4ff --- /dev/null +++ b/README.md~ @@ -0,0 +1,14 @@ +README +====== + +A simple readme file to toss into our project. + +To compile the code, run: + +`g++ -o build/hi-there src/hi-there.cpp` + +### Note: +No pull requests will be accepted for this repository, as it is meant to be used for demonstration purposes only. You are free to create a pull request to try it out, but no outside code will be merged into this project. + +It is highly recommended that you fork this project on GitHub so that you have full admin access to your own fork. This way you can practice with pushes and pull requests to see how they are done. +Be sure to have your SSH key set up and that your public key (located in ~/.ssh/id_rsa.pub) is added to your GitHub account. From b436286624a034fe75215797e0b094296d4e2646 Mon Sep 17 00:00:00 2001 From: Kenny Armstrong Date: Mon, 15 Jul 2019 09:06:10 -0400 Subject: [PATCH 2/5] updated the gitignore files to not upload backup files --- .gitignore | 2 +- README.md~ | 14 -------------- 2 files changed, 1 insertion(+), 15 deletions(-) delete mode 100644 README.md~ diff --git a/.gitignore b/.gitignore index f184a90..faf17a0 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,2 @@ build/* -CHANGELOG.md~ +*~ diff --git a/README.md~ b/README.md~ deleted file mode 100644 index f1cd4ff..0000000 --- a/README.md~ +++ /dev/null @@ -1,14 +0,0 @@ -README -====== - -A simple readme file to toss into our project. - -To compile the code, run: - -`g++ -o build/hi-there src/hi-there.cpp` - -### Note: -No pull requests will be accepted for this repository, as it is meant to be used for demonstration purposes only. You are free to create a pull request to try it out, but no outside code will be merged into this project. - -It is highly recommended that you fork this project on GitHub so that you have full admin access to your own fork. This way you can practice with pushes and pull requests to see how they are done. -Be sure to have your SSH key set up and that your public key (located in ~/.ssh/id_rsa.pub) is added to your GitHub account. From 7cb3b8e89615a72f3cd5b0a935660ecb70c79a5f Mon Sep 17 00:00:00 2001 From: Kenny Armstrong Date: Tue, 16 Jul 2019 08:40:28 -0400 Subject: [PATCH 3/5] updated Makefile to include install and uninstall instructions --- Makefile | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/Makefile b/Makefile index 360fcf1..03c4229 100644 --- a/Makefile +++ b/Makefile @@ -1,5 +1,15 @@ CC = g++ CFLAGS = -Wall +PREFIX = /usr/local hi-there: src/hi-there.cpp $(CC) $(CFLAGS) -o hi-there src/hi-there.cpp + +.PHONY: install +install: hi-there + mkdir -p $(DESTDIR)$(PREFIX)/bin + cp $< $(DESTDIR)$(PREFIX)/bin/hi-there + +.PHONY: uninstall +uninstall: + rm -f $(DESTDIR)$(PREFIX)/bin/hi-there From 0e6b20ac3d2194e1be6761c35d82298f3c2c6b36 Mon Sep 17 00:00:00 2001 From: Kenny Armstrong Date: Tue, 16 Jul 2019 10:14:59 -0400 Subject: [PATCH 4/5] updated README --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fc6c9c2..b7fa9d3 100644 --- a/README.md +++ b/README.md @@ -23,10 +23,22 @@ To build the program, run: make ``` +To install the program: + +``` +sudo make install +``` + To run the program, execute: ``` -./hi-there +hi-there +``` + +You can uninstall the program by running: + +``` +sudo make uninstall ``` ### Note: From edfdbc4f3abc5ec80fa81a6c56ab2503367fd7e4 Mon Sep 17 00:00:00 2001 From: "JC K. Mathis" Date: Wed, 20 Apr 2022 12:17:50 -0400 Subject: [PATCH 5/5] updated README to include info on ssh key --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index b7fa9d3..2452d98 100644 --- a/README.md +++ b/README.md @@ -46,3 +46,4 @@ No pull requests will be accepted for this repository, as it is meant to be used It is highly recommended that you fork this project on GitHub so that you have full admin access to your own fork. This way you can practice with pushes and pull requests to see how they are done. Be sure to have your SSH key set up and that your public key (located in ~/.ssh/id_rsa.pub) is added to your GitHub account. +Be sure your SSH key set up and that your public key is added to your GitHub acct.