Skip to content

Commit a0416e5

Browse files
Include a manifest.ini and update readme to explain how to package from source.
1 parent cf47b1d commit a0416e5

File tree

3 files changed

+22
-1
lines changed

3 files changed

+22
-1
lines changed

.gitignore

-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,3 @@
22
*.pyo
33
*.nvda-addon
44
addon/globalPlugins/audioScreen/deps
5-
addon/manifest.ini

addon/manifest.ini

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
name=audioScreen
2+
summary=Audio Screen
3+
version=1.5dev
4+
author=Unknown
5+
description=Allows you to "feel" images with your ears, while moving your finger around a touch screen on Windows 8 and above.
6+
url=http://www.github.com/nvaccess/audioScreen

readme.md

+16
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,22 @@ The frequency (in HZ) that represents blue. The frequency rises through aqua, gr
125125
#### highest frequency (red) in HZ
126126
The frequency (in HZ) that represents red. The frequency falls through orange, yellow, green, aqua, to blue. As the color spectrum raps around from blue back to red through purple, purples are represented by both the low (blue) frequency and high (red) frequency at differing volume ratios. I.e. A red-ish purple will be mostly the high (red) frequency with a small amount of the low (blue) frequency.
127127

128+
## Developing and Packaging from source
129+
130+
Clone the AudioScreen repository with the command:
131+
git clone https://www.github.com/nvaccess/audioScreen
132+
133+
[Python 2.7](http://www.python.org/) is required for building and developing this project.
134+
135+
AudioScreen depends on [libaudioverse](https://www.github.com/camlorn/libaudioverse):
136+
* cd to the audioScreen repository you cloned with git
137+
* Run the command: pip install --ignore-installed -t addon\globalPlugins\audioScreen\deps libaudioverse
138+
139+
### Packaging the NVDA add-on
140+
In the addon directory:
141+
* Edit manifest.ini to set the version of the add-on etc.
142+
* Create a zip file using your favorite zip tool, including both manifest.ini and the globalPlugins directory. It is important that both manifest.ini and globalPlugins be in the root of the zip file, I.e. no interviening directory. The zip file should have a.nvda-addon extension.
143+
128144
## Background
129145
For quite some time now, I have wanted a way to get access as a blind person to maps and basic diagrams with out the hassles of having to produce them in a tactile format.
130146

0 commit comments

Comments
 (0)