Tales of Vesperia Guide
Where to Start
- Visit https://hueyyeng.github.io/VesperiaGuide/ for the checklist guide.
- Use the checkbox as keep track of the events.
Requirements
- Python 3.6+ (have not tested with older version)
Cloning the Repository:
# Clone project using https
git clone https://github.com/hueyyeng/VesperiaGuide.git
Setting up a Virtualenv
It's recommended to install the project's dependencies into a virtual env.
Read more about Virtualenv over here: https://realpython.com/python-virtual-environments-a-primer/
# Go into the project directory
cd VesperiaGuide
# Create a new Python 3.6 virtualenv in a directory named 'env'
virtualenv -p python3.6 env
# Activate the virtualenv
source env/bin/activate
# Install Python dependencies
pip install -r requirements/base.txt
Using MkDocs to Generate the Guide
- Make sure the current working directory has
mkdocs.yml
, docs and custom_theme directories.
# Generate the guide and serve on localhost
mkdocs serve