Skip to content

Commit 3a47bee

Browse files
MyndexMyndex
committed
Update docs with proper APCA logo
1 parent 5f6b8d8 commit 3a47bee

11 files changed

+15
-13
lines changed

‎README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ APCA is the **Accessible Perceptual Contrast Algorithm**, a new way to predict c
4242
This is also where we discuss draft guidelines and proposals. Please post all comments or discussions here and not in the satellite repositories so they can be tracked and resolved.
4343

4444
## _DOCUMENTATION_
45-
- [**Main Readme Doc**](https://git.apcacontrast.com/documentation/README) This page includes the math, code walkthroughs and links for developer related goodies. If you link to dive into the deep end, this is a good start.
45+
- [**Main Readme Doc**](https://git.apcacontrast.com/documentation/README) This page includes the math, code walkthroughs and links for developer related goodies. If you'd like to dive into the deep end, this is a good start.
4646

4747
### _Simple Overview, Quickstart, and FAQ_
4848
These are intended for end users, and those interested in a plain language overview without a lot of the math & theory.

‎documentation/APCA_FAQ.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: simple
33
---
44

5-
# APCA & SAPC
5+
# APC<span class="flipH">A</span> & SAPC
66
## Frequently Asked Questions for the Accessible Perceptual Contrast Algorithm.
77
_--THIS IS A WORK IN PROGRESS--_
88

‎documentation/APCA_in_a_Nutshell.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
layout: simple
33
---
44

5-
# The Accessible Perceptual Contrast Algorithm
6-
APCA is a new method for calculating and predicting readability contrast. APCA is a part of the larger S-Luv Accessible Readability Color Appearance Model known as SARCAM (formerly SAPC). These models are specifically related to color appearance on self-illuminated RGB computer displays & devices, and also for modeling accessible user needs, with a focus on readability.
5+
# APC<span class="flipH">A</span> in a Nutshell
6+
Accessible Perceptual Contrast Algorithm is a new method for calculating and predicting readability contrast. APCA is a part of the larger S-Luv Accessible Color Appearance Model known as SACAM (formerly SAPC). These models are specifically related to color appearance on self-illuminated RGB computer displays & devices, and also for modeling accessible user needs, with a focus on readability.
77

88
## Lightness contrast L<sup>c</sup>
99
The APCA generates a lightness/darkness contrast value based on a minimum font size and color pair, and this value is perceptually based: that is, regardless of how light or dark the colors are, a contrast value of L<sup>c</sup>&nbsp;60 represents the same _perceived_ readability contrast. This is absolutely not the case with WCAG&nbsp;2.x, which far overstates contrast for dark colors to the point that 4.5:1 can be functionally unreadable when a color is near black. As a result, WCAG&nbsp;2.x contrast cannot be used for guidance designing "dark mode".

‎documentation/CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: simple
33
---
44

5-
# Contributing to APCA
5+
# Contributing to APC<span class="flipH">A</span>
66

77
First, thank you for taking the time to contribute! Myndex is focused on the underlying perception research, and the needs of supporting developers is its own monumental task! Thank you for help and discussion on how best to serve the developer community.
88

‎documentation/ImportantChangeNotices.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
---
22
layout: simple
33
---
4+
# APC<span class="flipH">A</span> BASE
45

5-
## SAPC/APCA CURRENT VERSION: 0.0.98G-4g-lut3 Constants: 4g
6+
## SAPC/APCA BAS ALGORITHM CURRENT VERSION: 0.0.98G-4g-lut3 Constants: 4g
67

78
### May 28 2022
89
Font lookup table revised, still for 0.98G 4g constants. General (all use case) lookup table.

‎documentation/LICENSE.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
### All Files Copyright (c) 2019-2021 by Myndex Research and Andrew Somers. All Rights Reserved.
22

3-
# — LICENSE —
3+
# APC<span class="flipH">A</span> — LICENSE —
44

55
### The Short Summary:
66
The files currently in this repository are presently considered pre-release, and as such do not have a permanent license attached. In this repositiory, all files present are under a time-barred beta license, and intended for use with web-based content only, and not for any other use without written permission.
77

8+
See also: [Minimum compliance](https://git.apcacontrast.com/documentation/minimum_compliance) to use "APCA" and related trademarks.
89
______________
910

1011
## W3 LICENSED FILES MOVED TO W3 REPO

‎documentation/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ layout: simple
2626
</p>
2727

2828
-----
29-
# APCA • SAPC • SACAM PRIMARY REPOSITORY
29+
# APC<span class="flipH">A</span> • SAPC • SAC<span class="flipH">A</span>M PRIMARY REPOSITORY
3030
Please make all comments or discussions here and not in the satellite repositories.
3131

3232
## Accessible Perceptual Contrast Algorithm

‎documentation/StandardObserverModel.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: simple
33
---
44

5-
# S-Luv Accessible Readable Color Appearance Model (SARCAM)
5+
# S-Luv Accessible Color Appearance Model (SAC<span class="flipH">A</span>M)
66
_(Formerly known as SAPC)_
77

88
## Standard Observer (Draft)

‎documentation/minimum_compliance.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
layout: simple
33
---
44

5-
# APCA™ MINIMUM INTEGRATION COMPLIANCE
6-
This brief document defines the minimum integrated features for a tool to be considered either _"APCA™ Compliant"_ or _"APCA™ Compatible"_ and other related issues. This document became necessary due to some unfortunate abuse and neglect in terms of properly presenting the technology.
5+
# APC<span class="flipH">A</span>™ INTEGRATION COMPLIANCE
6+
This brief document defines the minimum integrated features for a tool to be considered either _"APCA™ Compliant"_ or _"APCA™ Compatible"_ and other related issues. This document became necessary due to some unfortunate abuse and improper use of trademarks, code, and importantly in terms of properly presenting the technology.
77

88
## Compliance Levels Overview
99
- **APCA™ Contrast Value:** Requires a correct implementation of the APCA base algorithm only, with disclaimers of use.

‎documentation/regardingexponents.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: simple
33
---
4-
# Regarding Exponents
4+
# Regarding APC<span class="flipH">A</span> Exponents
55
#### The TLDR is "For non-HDR displays, the colorspace is simply selected by the three coefficients, and the pre-processing exponent."
66

77
## Input Stage Notes

‎documentation/repoList.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: simple
33
---
44

5-
# _Myndex and APCA Repositories_
5+
# Myndex and APC<span class="flipH">A</span> Repositories
66

77
- Myndex on GitHub: https://git.myndex.com/
88

0 commit comments

Comments
 (0)