Skip to content

Commit d1810b8

Browse files
committed
update README
1 parent a3dcdfa commit d1810b8

File tree

1 file changed

+14
-18
lines changed

1 file changed

+14
-18
lines changed

README.md

+14-18
Original file line numberDiff line numberDiff line change
@@ -8,24 +8,20 @@ The homepage can be accessed at: [smdogroup.github.io/homepage](https://smdogrou
88

99

1010
## Develop
11-
The website is currently under development and is offline.
12-
But there are two ways to preview it:
13-
14-
### 1. Build locally
15-
If you build for the first time, you'll install several python packages.
16-
This can be done by ```cd docs/source && pip install -r requirements.txt```.
17-
Then you can run ```docs/compile.sh``` to build the website.
18-
If it runs through, the main page can be accessed by opening
19-
```docs/build/html/index.html```.
20-
21-
### 2. Utilize Github action
22-
If you have trouble building locally, you could let github build the whole thing
23-
for you.
24-
You'll need to push your changes to main branch, which will
25-
trigger the auto-deploy to branch gh-pages.
26-
The status can be viewed by clicking [Actions](https://github.com/smdogroup/smdo-homepage/actions).
27-
When it's done, run ```git checkout gh-pages``` and ```git pull```, then you should have
28-
the ```index.html``` in the root folder.
11+
Push or PR to the main branch will trigger the GitHub workflow to build and
12+
deploy the website, which, upon finished, can be accessed at the URL above.
13+
14+
15+
### Preview the website locally
16+
If you build for the first time, you'll need to install several python packages:
17+
```cd docs/source && pip install -r requirements.txt```
18+
Then you can run ```cd docs && ./compile.sh``` to build the website.
19+
If it runs through, host it locally
20+
```python -m http.server build/html```
21+
then visit
22+
```localhost:8000/```
23+
in your browser to preview the website locally.
24+
2925

3026
## TODO
3127
- Resolve compatibility issues on mobile device

0 commit comments

Comments
 (0)