Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updated README to include info on ssh key #94

Open
wants to merge 6 commits into
base: readme-updates
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
build/*
CHANGELOG.md~
*~
15 changes: 15 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +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
43 changes: 39 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,49 @@
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 install the program:

```
sudo make install
```

To run the program, execute:

```
hi-there
```

You can uninstall the program by running:

```
sudo make uninstall
```

### 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.
Be sure your SSH key set up and that your public key is added to your GitHub acct.