Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
celestialtaha authored Apr 28, 2022
1 parent 31ef5a6 commit 72799bf
Showing 1 changed file with 3 additions and 45 deletions.
48 changes: 3 additions & 45 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,6 @@
# Webpage template for MILA-affiliated papers
# Webpage for the paper

[Template live demo](https://mila-udem.github.io/mila-paper-webpage)

# How to use

## Downloading the template

In the repo for which you wish to create a website, create an orphan branch
called `gh-pages`:

``` bash
$ cd [repository-name]
$ git checkout --orphan gh-pages
$ git rm -rf .
```

Download and unzip the template into the repository:

``` bash
$ wget https://github.com/mila-udem/mila-paper-webpage/archive/master.zip
$ unzip master.zip
$ mv mila-paper-webpage-master/* ./
$ rm -r master.zip mila-paper-webpage-master
```

Add all files as the first commit on this branch:

``` bash
$ git commit -a -m "First commit"
```

**Note: once you push to Github, even though your repository may be private, the
website will be publicly available to anyone using the webpage's web address.
You should develop locally until you're ready to go public.**
[Template live demo](https://mahdifarvardin.github.io/MTVital)

## Building the website locally

Expand Down Expand Up @@ -66,14 +34,4 @@ self-documented.
## Final step

Once you're ready, edit `_config.yml` so that `baseurl` is `"/repository-name"`,
commit, and push to Github:

``` bash
$ git push origin gh-pages
```

Your paper website should shortly be online at

```
https://[username].github.io/[repository-name]
```
commit, and push to Github.

0 comments on commit 72799bf

Please sign in to comment.