Skip to content

Commit d529e8f

Browse files
authored
Update README.md
1 parent 4bd5179 commit d529e8f

File tree

1 file changed

+2
-41
lines changed

1 file changed

+2
-41
lines changed

README.md

Lines changed: 2 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,3 @@
1-
# Project Website
1+
# SPoT: Subpixel Placement of Tokens in Vision Transformers
22

3-
This repository updates the [jekyllized version](https://github.com/shunzh/project_website) of the source code for the [Nerfies website](https://nerfies.github.io).
4-
You only need to change the content of [index.md](/index.md).
5-
It's possible to only write in markdown, but you can also use HTML to achieve fancier effects.
6-
7-
Here is this repository [example website](https://dsb-ifi.github.io/project-template/).
8-
9-
## Test it locally
10-
11-
Install [Jekyll](https://jekyllrb.com/docs/installation/), and run
12-
```
13-
jekyll serve
14-
```
15-
in this directory.
16-
17-
Then you can see the website at `http://127.0.0.1:4000`.
18-
19-
## To use it
20-
21-
- You need to copy from the `gh-pages` branch the `index.md` and workflow (`jekyll-build.yml`) files into your repository, and update the [index.md](/index.md). For instance
22-
```bash
23-
# create the local gh-pages
24-
git checkout -b gh-pages
25-
26-
# add the template remote
27-
git remote add template https://github.com/dsb-ifi/project-template.git
28-
# get the branch from the templates
29-
git fetch template gh-pages
30-
# checkout the files you need
31-
git checkout template/gh-pages -- index.md .github/workflows/jekyll-build.yml
32-
33-
# add the files to your local branch and commit
34-
git add index.md .github/workflows/jekyll-build.yml
35-
git commit index.md .github/workflows/jekyll-build.yml -m "Add template files"
36-
37-
# remove the remote
38-
git remote rm template
39-
40-
# Update index.md with your information
41-
```
42-
- In your repository, make sure that the `gh-pages` has permission within the "Deployment branches and tags"
3+
[Visit our Github Pages here!](https://dsb-ifi.github.io/SPoT/)

0 commit comments

Comments
 (0)