From 8453a769ef9c660ca734de42de642708c99f348a Mon Sep 17 00:00:00 2001 From: Aroy-Art Date: Sat, 21 Oct 2023 21:27:31 +0200 Subject: [PATCH] Fix: markdown styling --- README.md | 82 ++++++++++++++++++++++++++++++++++--------------------- 1 file changed, 51 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index 4d174d2..0130460 100644 --- a/README.md +++ b/README.md @@ -5,62 +5,71 @@ My try to make a Social media archiving web tool with django and gallery-dl - ## Features / Roadmap + *Note!* This is still in early development so stuff **will** change. -- - [ ] Scraping sites -- - [ ] Scheduled tasks -- - [ ] Site support -- - - [ ] [Furaffinity](https://www.furaffinity.net) -- - - [ ] [Twitter/X](https://twitter.com/) -- - [ ] Media support and previews -- - - [x] Flash (With [Ruffle](https://github.com/ruffle-rs/ruffle/)) -- - - [x] PDF (With HTML embed tag) -- - - [X] Image (With HTML img tag) -- - - [ ] other text documents +- [ ] Scraping sites +- [ ] Scheduled tasks +- [ ] Site support + - [ ] [Furaffinity](https://www.furaffinity.net) + - [ ] [Twitter/X](https://twitter.com/) +- [ ] Media support and previews + - [x] Flash (With [Ruffle](https://github.com/ruffle-rs/ruffle/)) + - [x] PDF (With HTML embed tag) + - [X] Image (With HTML img tag) + - [ ] other text documents --- ## Usage + ### Run without Docker - * **Step 1:** Clone repo +- **Step 1:** Clone repo + ```bash git clone https://git.aroy-art.com/Aroy/Gallery-Archivist.git ``` -* **Step 2:** Change dir to the new cloned repo +- **Step 2:** Change dir to the new cloned repo + ```bash cd Gallery-Archivist ``` -* **Step 3:** Make a python environment +- **Step 3:** Make a python environment + ```bash python3 -m venv venv ``` -* **Step 4:** Activate the new python environment +- **Step 4:** Activate the new python environment + ```bash source ./venv/bin/activate ``` -* **Step 5:** Install python dependencies +- **Step 5:** Install python dependencies + ```bash pip install -r requirements.txt ``` -* **Step 6:** Copy environment config file and change it to your liking +- **Step 6:** Copy environment config file and change it to your liking + ```bash cp env-sample .env ``` -* **Step 7:** Change directory to `./archivist` +- **Step 7:** Change directory to `./archivist` + ```bash cd ./archivist ``` -* **Step 8:** Run django server +- **Step 8:** Run django server + ```bash python3 manage.py runserver ``` @@ -69,19 +78,21 @@ python3 manage.py runserver It is possible to import data from saved gallery-dl json files -* **Step 1:** Make sure that you are in the root folder of the project. +- **Step 1:** Make sure that you are in the root folder of the project. + +- **Step 2:** Make sure to activate the python environment. -* **Step 2:** Make sure to activate the python environment. ```bash source ./venv/bin/activate ``` -* **Step 3:** Change directory to `./archivist` +- **Step 3:** Change directory to `./archivist` + ```bash cd ./archivist ``` -* **Step 4:** Import the json data and media file from gallery-dl +- **Step 4:** Import the json data and media file from gallery-dl replace `` with the path of the folder or json file to import ```bash @@ -90,39 +101,48 @@ python manage.py import_data ## Development +### Without Docker + *Note!* Instructions are made for a modern linux environment. - * **Step 1:** Clone repo +- **Step 1:** Clone repo + ```bash git clone https://git.aroy-art.com/Aroy/Gallery-Archivist.git ``` -* **Step 2:** Change dir to the new cloned repo +- **Step 2:** Change dir to the new cloned repo + ```bash cd Gallery-Archivist ``` -* **Step 3:** Make a python environment +- **Step 3:** Make a python environment + ```bash python3 -m venv venv ``` -* **Step 4:** Activate the new python environment +- **Step 4:** Activate the new python environment + ```bash source ./venv/bin/activate ``` -* **Step 5:** Install python dependencies +- **Step 5:** Install python dependencies + ```bash pip install -r requirements.txt ``` -* **Step 6:** Copy environment config file and change it to your liking +- **Step 6:** Copy environment config file and change it to your liking + ```bash cp env-sample .env ``` -* **Step 7:** Run django server +- **Step 7:** Run django server + ```bash python3 archivist/manage.py runserver -``` \ No newline at end of file +```