README.md

project-page-generator

Simple project-page generator for research, assuming hosted on GitHub Pages.

[demo page]

How to Deploy

1. Clone this repo

git clone git@github.com:Kei18/project-page-generator.git project-page
cd project-page

2. Change remote repo

git remote set-url origin {YOUR GITHUB REPO}

3. Edit your project-page

All you need is yarn. Initialize the repo with the following script:

yarn

Edit data.yaml, then:

yarn serve

You can see the website via http://localhost:1234.

4. Push

git push origin project-page

5. Publish

• Go to Your github repo -> Settings -> Pages
• Choose gh-pages in Branch menu.

Notes

Auto formatting (Prettier) when committing:

git config core.hooksPath .githooks && chmod a+x .githooks/pre-commit

Licence

This software is released under the MIT License, see LICENSE.txt.

Author

Keisuke Okumura is a Ph.D. student at Tokyo Institute of Technology, interested in controlling multiple moving agents.