Edits to the readme.

This commit is contained in:
Ada Werefox 2024-03-03 15:26:54 -06:00
parent 4dd9e43638
commit bfb1c44a9e
2 changed files with 36 additions and 30 deletions

View File

@ -1,12 +1,20 @@
# Tunic Tracker Redux # Tunic Tracker Redux
``` ```
_________ ___ ___ ________ ________ _________ ___ ___ ________ ___ ________
|\___ ___\\ \|\ \|\ ___ \|\ ____\ |\___ ___\\ \|\ \|\ ___ \|\ \|\ ____\
\|___ \ \_\ \ \\\ \ \ \\ \ \ \ \___| \|___ \ \_\ \ \\\ \ \ \\ \ \ \ \ \ \___|
\ \ \ \ \ \\\ \ \ \\ \ \ \ \ \ \ \ \ \ \\\ \ \ \\ \ \ \ \ \ \
\ \ \ \ \ \\\ \ \ \\ \ \ \ \____ \ \ \ \ \ \\\ \ \ \\ \ \ \ \ \ \____
\ \__\ \ \_______\ \__\\ \__\ \_______\ \ \__\ \ \_______\ \__\\ \__\ \__\ \_______\
\|__| \|_______|\|__| \|__|\|_______| \|__| \|_______|\|__| \|__|\|__|\|_______|
_________ ________ ________ ________ ________ ___ _________ ___ ________ ________
|\___ ___\\ __ \|\ __ \|\ ___ \|\ ____\|\ \|\___ ___\\ \|\ __ \|\ ___ \
\|___ \ \_\ \ \|\ \ \ \|\ \ \ \\ \ \ \ \___|\ \ \|___ \ \_\ \ \ \ \|\ \ \ \\ \ \
\ \ \ \ \ _ _\ \ __ \ \ \\ \ \ \_____ \ \ \ \ \ \ \ \ \ \ \\\ \ \ \\ \ \
\ \ \ \ \ \\ \\ \ \ \ \ \ \\ \ \|____|\ \ \ \ \ \ \ \ \ \ \ \\\ \ \ \\ \ \
\ \__\ \ \__\\ _\\ \__\ \__\ \__\\ \__\____\_\ \ \__\ \ \__\ \ \__\ \_______\ \__\\ \__\
\|__| \|__|\|__|\|__|\|__|\|__| \|__|\_________\|__| \|__| \|__|\|_______|\|__| \|__|
\|_________|
_________ ________ ________ ________ ___ __ _______ ________ _________ ________ ________ ________ ___ __ _______ ________
|\___ ___\\ __ \|\ __ \|\ ____\|\ \|\ \ |\ ___ \ |\ __ \ |\___ ___\\ __ \|\ __ \|\ ____\|\ \|\ \ |\ ___ \ |\ __ \
\|___ \ \_\ \ \|\ \ \ \|\ \ \ \___|\ \ \/ /|\ \ __/|\ \ \|\ \ \|___ \ \_\ \ \|\ \ \ \|\ \ \ \___|\ \ \/ /|\ \ __/|\ \ \|\ \
@ -14,21 +22,13 @@
\ \ \ \ \ \\ \\ \ \ \ \ \ \____\ \ \\ \ \ \ \_|\ \ \ \\ \| \ \ \ \ \ \\ \\ \ \ \ \ \ \____\ \ \\ \ \ \ \_|\ \ \ \\ \|
\ \__\ \ \__\\ _\\ \__\ \__\ \_______\ \__\\ \__\ \_______\ \__\\ _\ \ \__\ \ \__\\ _\\ \__\ \__\ \_______\ \__\\ \__\ \_______\ \__\\ _\
\|__| \|__|\|__|\|__|\|__|\|_______|\|__| \|__|\|_______|\|__|\|__| \|__| \|__|\|__|\|__|\|__|\|_______|\|__| \|__|\|_______|\|__|\|__|
________ _______ ________ ___ ___ ___ ___
|\ __ \|\ ___ \ |\ ___ \|\ \|\ \ |\ \ / /|
\ \ \|\ \ \ __/|\ \ \_|\ \ \ \\\ \ \ \ \/ / /
\ \ _ _\ \ \_|/_\ \ \ \\ \ \ \\\ \ \ \ / /
\ \ \\ \\ \ \_|\ \ \ \_\\ \ \ \\\ \ / \/
\ \__\\ _\\ \_______\ \_______\ \_______\/ /\ \
\|__|\|__|\|_______|\|_______|\|_______/__/ /\ __\
|__|/ \|__|
``` ```
I think we can do better with Tunic tracking so I'm gonna make something and if it works out that's awesome but for now I just wanna make it. I think we can do better with Tunic tracking so I'm gonna make something and if it works out that's awesome but for now I just wanna make it.
## Requirements ## Requirements
You'll need `python` to use this for now, so make sure you have that installed. You'll need `python` and `npm` to use this for now, so make sure you have those installed.
## Setup ## Setup
@ -40,14 +40,20 @@ Consider making a venv for this.
`python -m venv "./.venv"` `python -m venv "./.venv"`
Install the node modules with:
`npm install`
## Usage ## Usage
Make sure that the saved filepath in the script matches your filepath. It defaults to where *my* spoiler log is. Because of the way tailwindcss is used in development, you'll need to run two separate commands.
``` One for tailwindcss:
def import_entrances(spoiler_log='/path/to/Spoiler.log'):
```
Then run it with: `python manage.py tailwind start`
`python start.py` One for the django server:
`python manage.py runserver 8080`
You should then be able to connect by going to http://localhost:8080 in a browser.

View File

@ -7,7 +7,7 @@
<meta content="text/html;charset=utf-8" http-equiv="Content-Type" /> <meta content="text/html;charset=utf-8" http-equiv="Content-Type" />
<meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1" />
<meta charset="UTF-8" /> <meta charset="UTF-8" />
{% comment %} <meta http-equiv="refresh" content="3"> {% endcomment %} <meta http-equiv="refresh" content="3">
{% load static tailwind_tags %} {% load static tailwind_tags %}
{% tailwind_css %} {% tailwind_css %}
{% load static %} {% load static %}