Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
crescentheaded authored Jan 26, 2024
1 parent cddcfb5 commit 9d1b70c
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# [AccessibilityDocumentation](https://vodgroup.github.io/AccessibilityDocumentation/documentation/accessibilitydocumentation/)

## - What is this?
## What is this?
At the moment this project is a vague prototype of **wrapping the already-existing documentation of [Accessibility features available in iOS SDK](https://developer.apple.com/design/human-interface-guidelines/accessibility)** in a way **to make it easier to research** available in a form of a **web-resource**. In other words our goal is to find a solution for **making plain documentation more entertaining and requiring nothing more than a web-browser**. Call it an ***educational resource***.

Generally the project is dedicated to those who use the mentioned *toolkit* in their *work*: **developers**, **designers**, **researchers**. Nevertheless the content is planned that way so **one could learn Accessibility from its very *basics***. It is just not about raising *awareness*, at least for now.

## - How is it supposed to work?
## How is it supposed to work?

Currently our goal is to try out variable methods of documentation wrapping by implementing various **interactive solutions**, such as **step-by-step guides**, wide range of **media types** used and **[VoiceOver Designer](https://github.com/VODGroup/VoiceOverDesigner)** app prototype integration in order to find the most efficient *educational models*.

Expand All @@ -14,9 +14,9 @@ The *interactivity* is implemented by heavy relying on **[DocC](https://develope
Since it is only a *prototype*, having the resource hosted by **[GitHub Pages](https://pages.github.com)** seems to us a great option **to allow anyone to contribute to the project**. **GitHub Pages simply turns a GitHub repository into a *website*, which plays along *open-source development* fittingly**.

## - Why make it a website?
*Websites* is an exemplary **cross-platform solution**. Having resources available on the Net widens its **availability** - one has to have nothing more than a web browser and an Internet connection to **access the resource**.
*Websites* is an exemplary **cross-platform solution**. Having resources available on the Net widens its **availability** one has to have nothing more than a web browser and an Internet connection to **access the resource**.

## - What can I find in this repository specifically?
## What can I find in this repository specifically?

### Tutorials
To focus on the implementation of assistive technologies.
Expand All @@ -28,7 +28,7 @@ To study the concepts.
- Accessibility Properties in Code: How to Use Them. A brief overview of **implenting accessibility in apps**.
- Accessibility Features Explained: How People Use Assistive Technology. A thorough **description of the concepts** and its technological implementations in order **to provide a better understanding** of how it all works.

## - Can I contribute to the project?
## Can I contribute to the project?
Yes, **everyone is welcome to influence the project**, especially considering a non-commercial nature of it. It can be done by **comitting *ideas* and *fixes* to this repository** or **straightforwardly reaching someone from the team**. A few examples of doing this:
- **describe a problem** or **discuss on the topic** in **[Issues](https://github.com/VODGroup/AccessibilityDocumentation/issues)**;
- **propose a change** by creating a *pull request* to this repository;
Expand Down

0 comments on commit 9d1b70c

Please sign in to comment.