From 2ca047a7f01e42973927acc5c2b996050ac16290 Mon Sep 17 00:00:00 2001 From: Xevion Date: Wed, 4 Nov 2020 00:18:53 -0600 Subject: [PATCH] update readme with repo installation/execution instructions --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index c4bc9c9..ca99da0 100644 --- a/README.md +++ b/README.md @@ -7,3 +7,25 @@ These viewing methods are intended to be as simple as possible, mostly focusing Planned are text files, source code files, PDFs, and pictures. Everything else will be served as direct browser links (the browser handles all viewing) or as downloads. The project will be built in Django (as well as HTML/CSS/JS), my first ever project in the framework, so expect poorer standards, mishaps, some complex bugs (resolved with needlessly complex solutions) and such. + +## Setup + +``` +git clone https://github.com/Xevion/simple-viewer.git +pip install -r requirements.txt +``` + +Additionally, during development, you will want Sass files to be updated. + +In a separate terminal, run this command to automatically generate .css files from .scss files when they are edited. + +``` +cd ./viewer/static/css/ +sass --watch . +``` + +## Running `simple-viewer` + +``` +python manage.py runserver +```