diff --git a/README.md b/README.md new file mode 100644 --- /dev/null +++ b/README.md @@ -0,0 +1,73 @@ +# KDE Human Interface Guidelines website + +# Build and run + +## Getting the source code + +``` +git clone https://anongit.kde.org/websites/hig-kde-org.git +``` + + +## Setup dev environment + +### Install virtualenv + +Arch Linux + +``` +sudo pacman -S python-virtualenv +``` + +Fedora + +``` +sudo dnf install python3-virtualenv +``` + +Ubuntu/Debian + +``` +sudo apt-get install python3-virtualenv +``` + +Using pip + +``` +pip install virtualenv +``` + +### Create a virtual environment + +``` +virtualenv -p python3 env +source env/bin/activate +``` + +Install required packages + +``` +pip install -r requirements.txt +``` + + +## Build the website + +Go to the directory where `Makefile` is located and run + +``` +make html +``` + + +## Run the website + +Go to `build/html` directory and run a web server + +``` +python3 -m http.server +``` + +# Contributing + +If you are new to KDE devlopment, make sure to read [how to become a kde developer](https://community.kde.org/Get_Involved/development) first.