Github Example Readme



That is a pretty neat integration with GitHub; when Travis tests your GitHub changes, it. Let’s start with a very simple example that involves letting. For a quick and painless solution check out the last update at the end of the post. When you create a project on GitHub, it is highly encouraged to add a README file too. Thus, when someone visits.

Readme

In this blog I’ld like to cover the following topics:
– adding an example to the help documentation
-pushing to github
-untracking a file

Example

Add example to help documentation
Let’s add an example in the help documentation of the function we created. To add an example we will use roxygen2 and add the following to the roxygen2 code we wrote in the previous blog.

Push to github
To push to github, first log into github, and click create New respository and initialize with a README. You don’t necessarily have to have a README, but it is considered good form. The README descibes the project. In my README I wrote the following.

The “#” sign is not a comment, it’s what markdown uses to recognize header. Markdown is the default file type github uses to create a README.

Github readme.md example

However, we don’t yet have a README on our computer. This will create a problem when we try to send our work to github, so we need to add the README to our local computer. First, we will see what (if anything) we are connected to by using the command git remote -v. The “-v” stands for verbose.

Github Profile Readme Examples

When I did this I wasn’t connected to anything, so I added the link to my repository using git remote add.

ReadmeGithub profile readme examples

Here, origin refers to the branch of my repository. I’ll try to discuss branching some other time.
Next, we need to pull down that README.md by using the command git pull.

Github Example Readme Page

Here origin is the branch on github and master is the branch on our computer. Finally, we’ll use the command git push to push to github.

Github Readme Example Code

Now, we should have our package on github.