Add draft functional specifications

7 months ago · d068ce6137
parent 131d32c781
commit d068ce6137
4 changed files with 1023 additions and 0 deletions
--- a/.gitignore
+++ b/.gitignore
@ -4,6 +4,10 @@

 /homepage/_news.html

+# Functional specifications build products
+/docs/FnSpecs.*
+!/docs/FnSpecs.tex
+
 # Jekyll
 /homepage/_site
 /homepage/.sass-cache
--- a/docs/FnSpecs.tex
+++ b/docs/FnSpecs.tex
--- a/docs/options.md
+++ b/docs/options.md
@ -1,5 +1,7 @@
 # Options and advanced options

+**Note:** OpenTally is in the process of transitioning to being defined by formal functional specifications. A draft of the functional specifications can be found [here]({{ site.baseurl }}/docs/FnSpecs.pdf), which describes many of these options in greater detail.
+
 ## Preset

 The preset dropdown allows you to choose from a hardcoded list of preloaded STV counting rules. These are:
--- a/scripts/build_homepage.sh
+++ b/scripts/build_homepage.sh
@ -5,3 +5,4 @@ DESTDIR='/home/runassudo/Documents/Work/School Cloud Data/unenc/public/www/opent
 cd homepage
 bundle exec jekyll build -d "$DESTDIR"
 cd ..
+cp docs/FnSpecs.pdf "$DESTDIR/docs"