Merge pull request #70 from jacobxperez/website

Moves website branch to the main branch

.github/CONTRIBUTING.md

@@ -8,6 +8,9 @@ Welcome designers, help us improve Atkinson Hyperlegible Pro for everyone. Befor
 
 * [Project Scope](#project-scope)
 * [Opening Up The Source Files](#opening-up-the-source-files)
+* [Compile Website](#compile-website)
+  * [Framework](#framework)
+  * [CSS Files](#css-files)
 * [Pull Requests](#pull-requests)
 * [Issues](#issues)
   * [Help Us Fix An Issue](#help-us-fix-an-issue)
@@ -29,6 +32,30 @@ We use [FontForge](https://fontforge.org/en-US/) which allows you to create and
 modify postscript, truetype and opentype fonts. You can save fonts in many different
 outline formats, and generate bitmaps.
 
+Install devDependencies on your machine with [npm](https://www.npmjs.com/)
+
+    npm install
+
+## Compile Website
+
+On your terminal run these scripts to compile
+
+* `npm run dev` serve current development build
+* `npm run watch` watch for changes but does not start server
+* `npm run build` makes current build
+
+### Framework
+
+We are using [Rams](https://github.com/jacobxperez/rams) as our website framework. Do **not** edit the [core](https://github.com/jacobxperez/atkinson-hyperlegible-pro/tree/main/src/css/core) files because they are part of the Rams core framework files. However, you can edit the [custom](https://github.com/jacobxperez/atkinson-hyperlegible-pro/tree/main/src/css/custom) folder files the [main.css](https://github.com/jacobxperez/atkinson-hyperlegible-pro/blob/main/src/css/main.css) or the [var.css](https://github.com/jacobxperez/atkinson-hyperlegible-pro/blob/main/src/css/var.css) if any change is accepted by the maintainers. Any new CSS file should be added in the [custom](https://github.com/jacobxperez/atkinson-hyperlegible-pro/tree/main/src/css/custom) folder then linked in the [main.css](https://github.com/jacobxperez/atkinson-hyperlegible-pro/blob/main/src/css/main.css) file for compiling.
+
+### CSS Files
+
+* [/css](https://github.com/jacobxperez/atkinson-hyperlegible-pro/tree/main/website/css/)
+  * [core](https://github.com/jacobxperez/atkinson-hyperlegible-pro/tree/main/website/css/core) (important files for compiling)
+  * [custom](https://github.com/jacobxperez/atkinson-hyperlegible-pro/tree/main/website/css/custom) (add custom modules here)
+  * [main.css](https://github.com/jacobxperez/atkinson-hyperlegible-pro/blob/main/website/css/main.css) (compile to produce the final CSS)
+  * [var.css](https://github.com/jacobxperez/atkinson-hyperlegible-pro/blob/main/website/css/var.css) (variables for font, colors, and more)
+
 ## Pull Requests
 
 Before embarking on any significant pull request, ask first by submitting an

.parcelrc

@@ -0,0 +1,18 @@
+{
+    "extends": [
+        "@parcel/config-default"
+    ],
+    "namers": [
+        "@mischnic/parcel-namer-preserve-structure",
+        "..."
+    ],
+    "optimizers": {
+        "*.html": [
+            "parcel-optimizer-friendly-urls",
+            "..."
+        ],
+        "*.js": [
+            "@parcel/optimizer-terser"
+        ]
+    }
+}

.postcssrc

@@ -0,0 +1,10 @@
+{
+    "plugins": {
+        "postcss-mixins": true,
+        "postcss-import": true,
+        "postcss-advanced-variables": true,
+        "postcss-nesting": true,
+        "postcss-custom-selectors": true,
+        "postcss-variable-compress": true
+    }
+}

.prettierrc

@@ -0,0 +1,26 @@
+{
+    "printWidth": 80,
+    "proseWrap": "always",
+    "trailingComma": "es5",
+    "useTabs": false,
+    "tabWidth": 4,
+    "semi": true,
+    "singleQuote": false,
+    "bracketSpacing": false,
+    "singleAttributePerLine": false,
+    "arrowParens": "always",
+    "overrides": [
+        {
+            "files": "*.js",
+            "options": {
+                "singleQuote": true
+            }
+        },
+        {
+            "files": "*.html",
+            "options": {
+                "printWidth": 100
+            }
+        }
+    ]
+}

README.md

@@ -14,6 +14,8 @@ An updated and extended version of [Atkinson Hyperlegible](https://github.com/go
 * [Flip the Zero](#flipping-the-zero)
 * [Contributing](#contributing)
 * [License](#license)
+  * [Font](#font)
+  * [Code](#code)
 
 ## Overview
 
@@ -32,7 +34,7 @@ Atkinson Hyperlegible Pro is an updated and extended version of the original typ
 
 Designed for low-vision readers, certain letters and numbers can be hard to distinguish from one another. Atkinson Hyperlegible Pro differentiates common misinterpreted letters and numbers using various design techniques: B vs. 8, 1 vs. L vs. l vs. I. Recognizable Footprints: Character boundaries are clearly defined, ensuring understanding across the visual-ability spectrum.
 
-> `Q vs G, E vs F, p vs q, i vs r, O vs 0`
+Unless required by applicable law or agreed to in writing, software
 
 Differentiated letterform’s: Similar letter pairs are differentiated from each other to dramatically increase legibility. Unambiguous Characters: designed to increase legibility and distinction.
 
@@ -75,10 +77,22 @@ Help us improve Atkinson Hyperlegible Pro for everyone, any contribution or feed
 Please read our [contributing guidelines](https://github.com/jacobxperez/atkinson-hyperlegible-pro/blob/main/.github/CONTRIBUTING.md)
 before embarking on any significant pull request.
 
-## License
+## LICENSE
 
-SIL Open Font License, v1.1. See [LICENSE.txt](LICENSE.txt) for details.
+### Font
 
----
+Copyright (C) 2020 [Braille Institute of America, Inc](https://brailleinstitute.org/).
+
+Licensed under the SIL Open Font License, v1.1. See [LICENSE.txt](LICENSE.txt) for details.
+
+### Code
+
+Copyright (C) 2023 [Jacob Perez](https://jacobxperez.github.io/blog/)
+
+Licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0) (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+<http://www.apache.org/licenses/LICENSE-2.0>
 
-Learn more at [The Braille Institute](https://brailleinstitute.org/freefont).
+Unless required by applicable law or agreed to in writing, software