Skip to content

Commit

Permalink
Adding some information about not pushing to this remote.
Browse files Browse the repository at this point in the history
  • Loading branch information
jlconlin committed Jan 17, 2017
1 parent 7e673cc commit 9a9fd02
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README-jekyll.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,19 @@ This repository contains the required stuff to make the NJOY website and keep it
## Using jekyll-website
For all projects under the NJOY organization, this repository should be created as a git 'subtree' in the `docs` directory. This will ensure consistency across all the projects as well as make the documentation for each accessible from the website.

In order to prevent pushing to this repository one should set the push url for this remote in git like this:

```bash
git remote set-url --push <name> no_push
```
Here `<name>` is the name of the remote (probably `jekyll`). What this tells git is whenever you try to push to this remote, simply push to the url `no_push` which doesn't exist.

Alternatively, you can set the push url to the url of the remote of the real repository like:

```bash
git remote set-url --push jekyll [email protected]:njoy/njoy.github.io.git
```
as is done for the [njoy.github.io](https://github.com/njoy/njoy.github.io) repository.

## License
This repository---and all repositories under the NJOY organization---are licensed according to the [LICENSE](LICENSE.md) file

0 comments on commit 9a9fd02

Please sign in to comment.