diff --git a/README.md b/README.md index 09d7ee2..7f9fb16 100644 --- a/README.md +++ b/README.md @@ -28,11 +28,7 @@ OpenTally is highly customisable, including options for: ## Online usage -After preparing the [BLT file](https://yingtongli.me/git/OpenTally/about/docs/blt.md), open the web UI. Select the BLT file, and click *Count*. OpenTally will count the election and display the results in a count sheet. - -By clicking *Show advanced options*, you can customise the options used for the count. A detailed explanation of the various options can be found [here](/opentally/docs/options.html). - -Once the count is complete, you can click *Print result* to generate a printable result report. +See the [quick start guide](/opentally/docs/quick-start.html) for how to use OpenTally online. ## Command line usage diff --git a/docs/quick-start.md b/docs/quick-start.md new file mode 100644 index 0000000..03ee796 --- /dev/null +++ b/docs/quick-start.md @@ -0,0 +1,19 @@ +# Quick start guide + +Prepare a [BLT file](https://yingtongli.me/git/OpenTally/about/docs/blt.md) containing the ballot papers in the election. If you would just like to see a demonstration election, you can download a sample BLT file here. + +Launch OpenTally at https://yingtongli.me/opentally/stv/. + +In the top-right corner of the page, click *Browse* and select the BLT file you prepared or downloaded: + +![Browse button](/opentally/assets/docs/005.png){: style="max-height:45px;display:block;margin:0 auto" } + +Click the *Count* button to generate the result sheet for the election: + +![Result sheet](/opentally/assets/docs/010.png){: style="max-height:500px;display:block;margin:0 auto" } + + + +To change the STV rules used to count the election, click the *Preset* dropdown at the top of the page, and choose a preset. Alternatively, click *Show advanced options*. A detailed explanation of the various presets and options can be found [here](/opentally/docs/options.html). + +Once the count is complete, you can click *Print result* to generate a printable result report or PDF. To ensure the result report displays correctly, check that the paper size in the print window matches the paper size selected in OpenTally, the print orientation is set to landscape, and the scale is set to 100%. diff --git a/homepage/_config.yml b/homepage/_config.yml index c53c7cf..3d9d399 100644 --- a/homepage/_config.yml +++ b/homepage/_config.yml @@ -26,3 +26,6 @@ kramdown: # - vendor/cache/ # - vendor/gems/ # - vendor/ruby/ + +keep_files: + - stv diff --git a/homepage/_layouts/default.html b/homepage/_layouts/default.html index 1b10045..19a5408 100644 --- a/homepage/_layouts/default.html +++ b/homepage/_layouts/default.html @@ -6,7 +6,7 @@ - {% if post.title %}{{ post.title }}{% else %}{{ site.title }}{% endif %} + {% if page.title %}{{ page.title }}{% else %}{{ site.title }}{% endif %} @@ -23,8 +23,9 @@
  • Source Code
    • diff --git a/homepage/_layouts/docs.html b/homepage/_layouts/docs.html new file mode 100644 index 0000000..2d915ca --- /dev/null +++ b/homepage/_layouts/docs.html @@ -0,0 +1,37 @@ +--- +layout: default +--- + +
    +
    +
    +
    +

    {{ page.title }}

    + +
    + {{ content }} +
    +
    +
    + +
    +
    +
    +
    + + diff --git a/homepage/_layouts/post.html b/homepage/_layouts/post.html index 9dda375..25a00ab 100644 --- a/homepage/_layouts/post.html +++ b/homepage/_layouts/post.html @@ -6,6 +6,21 @@ layout: default

    {{ page.title }}

    - {{ content }} +
    + {{ content }} +
    + + diff --git a/homepage/assets/docs/005.png b/homepage/assets/docs/005.png new file mode 100644 index 0000000..34e3af3 Binary files /dev/null and b/homepage/assets/docs/005.png differ diff --git a/homepage/assets/docs/010.png b/homepage/assets/docs/010.png new file mode 100644 index 0000000..8eb80e7 Binary files /dev/null and b/homepage/assets/docs/010.png differ diff --git a/homepage/about.md b/homepage/docs/about.md similarity index 57% rename from homepage/about.md rename to homepage/docs/about.md index 648190f..34e5a52 100644 --- a/homepage/about.md +++ b/homepage/docs/about.md @@ -1,12 +1,6 @@ --- -layout: post +layout: docs title: "About OpenTally" ---
    {% include_absolute '../README.md' %}
    - - diff --git a/homepage/docs/options.md b/homepage/docs/options.md index 569e1f0..4eabf97 100644 --- a/homepage/docs/options.md +++ b/homepage/docs/options.md @@ -1,23 +1,10 @@ --- -layout: post +layout: docs title: "Advanced options" ---
    {% include_absolute '../docs/options.md' %}
    - - diff --git a/homepage/docs/quick-start.md b/homepage/docs/quick-start.md new file mode 100644 index 0000000..1e69e0c --- /dev/null +++ b/homepage/docs/quick-start.md @@ -0,0 +1,6 @@ +--- +layout: docs +title: "Quick start guide" +--- + +
    {% include_absolute '../docs/quick-start.md' %}
    diff --git a/homepage/index.html b/homepage/index.html index 1d96378..59e7de3 100644 --- a/homepage/index.html +++ b/homepage/index.html @@ -1,5 +1,6 @@ --- layout: default +title: "OpenTally: Advanced online election counting" --- @@ -11,12 +12,12 @@ layout: default

    Advanced online election counting

    Count instant runoff and single transferable vote elections for free, no downloads or sign-up required

    - Get Started - Learn More + Launch OpenTally + Quick Start Guide
    -
    Screenshot of OpenTally
    +
    Screenshot of OpenTally