diff --git a/README.md b/README.md index 489dfa5..774fc0a 100644 --- a/README.md +++ b/README.md @@ -8,24 +8,20 @@ The homepage can be accessed at: [smdogroup.github.io/homepage](https://smdogrou ## Develop -The website is currently under development and is offline. -But there are two ways to preview it: - -### 1. Build locally -If you build for the first time, you'll install several python packages. -This can be done by ```cd docs/source && pip install -r requirements.txt```. -Then you can run ```docs/compile.sh``` to build the website. -If it runs through, the main page can be accessed by opening -```docs/build/html/index.html```. - -### 2. Utilize Github action -If you have trouble building locally, you could let github build the whole thing -for you. -You'll need to push your changes to main branch, which will -trigger the auto-deploy to branch gh-pages. -The status can be viewed by clicking [Actions](https://github.com/smdogroup/smdo-homepage/actions). -When it's done, run ```git checkout gh-pages``` and ```git pull```, then you should have -the ```index.html``` in the root folder. +Push or PR to the main branch will trigger the GitHub workflow to build and +deploy the website, which, upon finished, can be accessed at the URL above. + + +### Preview the website locally +If you build for the first time, you'll need to install several python packages: +```cd docs/source && pip install -r requirements.txt``` +Then you can run ```cd docs && ./compile.sh``` to build the website. +If it runs through, host it locally +```python -m http.server build/html``` +then visit +```localhost:8000/``` +in your browser to preview the website locally. + ## TODO - Resolve compatibility issues on mobile device