Add header, assets downloads, init guide

README.md

@@ -17,6 +17,7 @@ A repository containing implementations and experiments for the upcoming paper _
   - [Attribution](#attribution)
     - [Authors](#authors)
     - [Datasets](#datasets)
+    - [Assets](#assets)
     - [Quotes](#quotes)
 
 ## Usage
@@ -34,6 +35,11 @@ The current version of the `DeepART` project does not yet have full usage instru
 - [Indoor Scene Recognition](https://web.mit.edu/torralba/www/indoor.html)
   - [Direct Link](http://groups.csail.mit.edu/vision/LabelMe/NewImages/indoorCVPR_09.tar)
 
+### Assets
+
+- [Deep-learning icons created by Freepik - Flaticon](https://www.flaticon.com/free-icons/deep-learning) ([deep-learning_2080961](https://www.flaticon.com/free-icon/deep-learning_2080961))
+- [Unlearned Font](https://www.1001fonts.com/unlearned-font.html)
+
 ### Quotes
 
 > To achieve great things, two things are needed: a plan and not quite enough time

docs/make.jl

@@ -55,6 +55,58 @@ if haskey(ENV, "DOCSARGS")
     end
 end
 
+
+# -----------------------------------------------------------------------------
+# DOWNLOAD LARGE ASSETS
+# -----------------------------------------------------------------------------
+
+# Point to the raw FileStorage location on GitHub
+top_url = raw"https://media.githubusercontent.com/media/AP6YC/FileStorage/main/DeepART/"
+
+# List all of the files that we need to use in the docs
+files = [
+    "header.png",
+]
+
+# Make a destination for the files, accounting for when folder is AdaptiveResonance.jl
+assets_folder = joinpath("src", "assets")
+if basename(pwd()) == PROJECT_NAME || basename(pwd()) == PROJECT_NAME * ".jl"
+    assets_folder = joinpath(DOCS_NAME, assets_folder)
+end
+
+download_folder = joinpath(assets_folder, "downloads")
+mkpath(download_folder)
+download_list = []
+
+# Download the files one at a time
+for file in files
+    # Point to the correct file that we wish to download
+    src_file = top_url * file * "?raw=true"
+    # Point to the correct local destination file to download to
+    dest_file = joinpath(download_folder, file)
+    # Add the file to the list that we will append to assets
+    push!(download_list, dest_file)
+    # If the file isn't already here, download it
+    if !isfile(dest_file)
+        download(src_file, dest_file)
+        @info "Downloaded $dest_file, isfile: $(isfile(dest_file))"
+    else
+        @info "File already exists: $dest_file"
+    end
+end
+
+# Downloads debugging
+detailed_logger = Logging.ConsoleLogger(stdout, Info, show_limited=false)
+with_logger(detailed_logger) do
+    @info "Current working directory is $(pwd())"
+    @info "Assets folder is:" readdir(assets_folder, join=true)
+    # full_download_folder = joinpath(pwd(), "src", "assets", "downloads")
+    @info "Downloads folder exists: $(isdir(download_folder))"
+    if isdir(download_folder)
+        @info "Downloads folder contains:" readdir(download_folder, join=true)
+    end
+end
+
 # -----------------------------------------------------------------------------
 # GENERATE
 # -----------------------------------------------------------------------------
@@ -77,6 +129,7 @@ makedocs(
     ),
     pages=[
         "Home" => "index.md",
+        "Guide" => "man/guide.md",
         "Internals" => [
             "Index" => "man/full-index.md",
             "Dev Index" => "man/dev-index.md",

docs/src/index.md

@@ -4,7 +4,9 @@ DocTestSetup = quote
 end
 ```
 
-# DeepART.jl
+![header](assets/downloads/header.png)
+
+---
 
 Documentation for the `DeepART.jl` project.
 
@@ -37,5 +39,16 @@ println("DeepART v$(DEEPART_VERSION) docs built $(Dates.now()) with Julia $(VERS
 
 ## Citation
 
-If you make use of this project, please generate your citation with the [CITATION.cff](../../CITATION.cff) file of the repository.
-Alternatively, you may use the following BibTeX entry for the JOSS paper associated with the repository:
+If you make use of this project, please generate your citation with the [CITATION.cff](https://github.com/AP6YC/DeepART/blob/main/CITATION.cff) file of the repository.
+Alternatively, you may use the following BibTeX entry:
+
+```bibtex
+@software{Petrenko_AP6YC_DeepART_2024,
+    author = {Petrenko, Sasha},
+    doi = {10.5281/zenodo.10896042},
+    month = jan,
+    title = {{AP6YC/DeepART}},
+    url = {https://github.com/AP6YC/DeepART},
+    year = {2024}
+}
+```

docs/src/man/guide.md

@@ -0,0 +1,3 @@
+# Guide
+
+TODO: this is where the user guide will go for the project.