From 5610201fc8e5c89d5da96951c830835735c95ba9 Mon Sep 17 00:00:00 2001
From: deltreey <deltreey51x@gmail.com>
Date: Fri, 21 Jun 2024 12:38:27 -0500
Subject: [PATCH] add some build/run instructions, fix makefile code, and
ignore some files
---
.gitignore | 123 +++++++++++++++++++++++++++++++
nwn/nwnprc/DocGen/trunk/README | 22 +++++-
nwn/nwnprc/DocGen/trunk/makefile | 2 +-
3 files changed, 145 insertions(+), 2 deletions(-)
diff --git a/.gitignore b/.gitignore
index 989f618d..a0d1b05e 100644
--- a/.gitignore
+++ b/.gitignore
@@ -27,3 +27,126 @@ nwn/nwnprc/trunk/makefile.temp
*.temp
*.temp
nwn/nwnprc/trunk/makefile.temp
+nwn/nwnprc/DocGen/trunk/2da/*.2da
+nwn/nwnprc/DocGen/trunk/tlk/*.tlk
+nwn/nwnprc/DocGen/trunk/manual/
+nwn/nwnprc/DocGen/trunk/errorlog
+
+# Created by https://www.toptal.com/developers/gitignore/api/intellij+all,java
+# Edit at https://www.toptal.com/developers/gitignore?templates=intellij+all,java
+
+### Intellij+all ###
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+
+# AWS User-specific
+.idea/**/aws.xml
+
+# Generated files
+.idea/**/contentModel.xml
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn. Uncomment if using
+# auto-import.
+# .idea/artifacts
+# .idea/compiler.xml
+# .idea/jarRepositories.xml
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+# *.iml
+# *.ipr
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# SonarLint plugin
+.idea/sonarlint/
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser
+
+### Intellij+all Patch ###
+# Ignore everything but code style settings and run configurations
+# that are supposed to be shared within teams.
+
+.idea/*
+
+!.idea/codeStyles
+!.idea/runConfigurations
+
+### Java ###
+# Compiled class file
+*.class
+
+# Log file
+*.log
+
+# BlueJ files
+*.ctxt
+
+# Mobile Tools for Java (J2ME)
+.mtj.tmp/
+
+# Package Files #
+*.jar
+*.war
+*.nar
+*.ear
+*.zip
+*.tar.gz
+*.rar
+
+# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
+hs_err_pid*
+replay_pid*
+
+# End of https://www.toptal.com/developers/gitignore/api/intellij+all,java
\ No newline at end of file
diff --git a/nwn/nwnprc/DocGen/trunk/README b/nwn/nwnprc/DocGen/trunk/README
index 22c667f9..b08780cb 100644
--- a/nwn/nwnprc/DocGen/trunk/README
+++ b/nwn/nwnprc/DocGen/trunk/README
@@ -16,6 +16,7 @@ From NWN base:
racialtypes.2da
all race_feat_*.2da
all cls_*.2da
+ all *.tlk
From the PRC:
@@ -72,4 +73,23 @@ above.
See codegen_example -directory for example template and 2das. To see the
results from it, run (replace \ with / if not running on windoze)
- java CodeGen exa_ codegen_example\example.nss codegen_example\Foo.2da codegen_example\Bar.2da
\ No newline at end of file
+ java CodeGen exa_ codegen_example\example.nss codegen_example\Foo.2da codegen_example\Bar.2da
+
+## Build Docs
+
+As it currently goes, this seems to run best on windows (`xcopy` is required). There is a makefile, but xcopy + make
+are not cooperating with each other, so here are the commands to build the docs.
+
+```commandline
+xcopy "Main Manual Files" manual /iey
+java -Xmx300m -Xms300m -cp "imageio_tga_1.1.0.jar;." prc/autodoc/Main
+java -jar DocGen.jar manual
+```
+
+## Testing the Site
+
+You'll want to use a server to host the docs so you can load them correctly. I like python for this
+
+```commandline
+python -m http.server
+```
\ No newline at end of file
diff --git a/nwn/nwnprc/DocGen/trunk/makefile b/nwn/nwnprc/DocGen/trunk/makefile
index fb250d32..c08cdbe2 100644
--- a/nwn/nwnprc/DocGen/trunk/makefile
+++ b/nwn/nwnprc/DocGen/trunk/makefile
@@ -1,6 +1,6 @@
COMPILER = javac
FLAGS = -Xlint:all -g -source 11 -target 11
-RUNPARAMS = -Xmx300m -Xms300m -cp imageio_tga_1.1.0.jar\;
+RUNPARAMS = -Xmx300m -Xms300m -cp "imageio_tga_1.1.0.jar\;."
TARGET = prc/*.java \
prc/autodoc/*.java \
prc/utils/*.java \