diff --git a/README.md b/README.md index e0e013d7d70f70c00619309fadfca48e0c606095..37eead716376ddc97fbbef49c20714261171d831 100644 --- a/README.md +++ b/README.md @@ -38,10 +38,10 @@ Pd has been designed with an emphasis on generating sound, video, 2D/3D graphics, and connecting through sensors, input devices, and MIDI as well as OSC devices. -Pd has a special emphasis on generating audio and/or video in real time, with +Pd has a special emphasis on generating audio and/or video in real-time, with low latency. Much of its design focuses on receiving, manipulating, and delivering high-quality audio signals. Specifically, the software addresses -the problem of how to do this efficiently and reliably on general purpose +the problem of how to do this efficiently and reliably on general-purpose operating systems like OSX, Windows, Debian, etc.-- i.e., systems designed mainly for multi-tasking. @@ -114,7 +114,7 @@ You can also just go to the [OBS Download](https://software.opensuse.org/downloa ### Build Guide -Purr Data is usually built by just running `make` in the toplevel source directory after checking out the sources from its git repository. This works across all supported platforms (Linux, Mac and Windows at this time). The Makefile also offers the customary targets to clean (`make clean`, or `make realclean` to put the sources in pristine state again) and to roll a self-contained distribution tarball (`make dist`), as well as some other convenience targets (please check the comments at the beginning of the Makefile for more information). +Purr Data is usually built by just running `make` in the top level source directory after checking out the sources from its git repository. This works across all supported platforms (Linux, Mac and Windows at this time). The Makefile also offers the customary targets to clean (`make clean`, or `make realclean` to put the sources in pristine state again) and to roll a self-contained distribution tarball (`make dist`), as well as some other convenience targets (please check the comments at the beginning of the Makefile for more information). However, to make this work, you will most likely have to install some prerequisites first: *build tools* such as a C/C++ compiler and the make program itself, as well as *dependencies*, the libraries that Purr Data needs. Detailed instructions for each of the supported platforms are given below. @@ -335,12 +335,12 @@ A few guidelines: * Develop incrementally. Small, solid improvements to the software are preferable to large, disruptive ones. * Try not to duplicate existing functionality. - For backwards compatibility Purr Data ships many legacy + For backward compatibility Purr Data ships many legacy libraries which unfortunately duplicate the same functionality. This makes it harder to learn how to use Pd, and makes it burdensome to read patches and keep track of all the disparate implementations. * Keep dependencies to a minimum. Cross-platform dependency handling is - unfortunately still an open research problem. In the even that you need + unfortunately still an open research problem. In the event that you need an external library dependency, please mirror it at git.purrdata.net so that the build system doesn't depend on the availability of external infrastructure. @@ -374,16 +374,16 @@ Here are some of the current tasks: recent link...): http://sourceforge.net/p/pure-data/svn/HEAD/tree/tags/externals/pureunity/pureunity-0.0/ * Adding support for double precision to the external libraries that ship with purr-data - * Skills needed: Knowledge about data types in C language(specially float and double) + * Skills needed: Knowledge about data types in C language(especially float and double) * Status: The core classes of purr data and the freeverb~ external library have been changed to support both float and double but still the remaining external libraries only have support for single precision. - The task ahead is to add double precision support to these external libraries. - As per the current resources we have the merge requests that have been used to add double + The task ahead is to add double-precision support to these external libraries. + As per the current resources, we have the merge requests that have been used to add double precision support to the core libraries: https://git.purrdata.net/jwilkes/purr-data/merge_requests?scope=all&utf8=%E2%9C%93&state=merged&author_username=pranay_36 - And Katja Vetter's double precision patches to the pd-double project which were - actually used for adding double precision support to the core libraries of purr-data. + And Katja Vetter's double-precision patches to the pd-double project which were + actually used for adding double-precision support to the core libraries of purr-data. https://github.com/pd-projects/pd-double/commit/982ad1aa1a82b9bcd29c5b6a6e6b597675d5f300 ### Human Interface Guidelines @@ -392,7 +392,7 @@ Here are some of the current tasks: Pd is a multi-window application that consists of three parts: -1. A main window, called the "Pd Window" or "Console Window". This window +1. The main window, called the "Pd Window" or "Console Window". This window displays informational and error messages for Pd programs. 2. One or more "canvas" windows-- aka "patch" windows, used to display the diagrams that make up a Pd program. @@ -404,14 +404,14 @@ should be designed so that they can be manipulated using only the keyboard. ### Hooks for new users It should also be possible to produce sound and interact when a new user runs -program for the very first time. In every release, there should be a link at +the program for the very first time. In every release, there should be a link at the bottom of the Console Window to a short game written in Pd that demonstrates one or more of the capabilities of the Pd environment. The game should be designed to be fun outside of its efficacy as a demonstration of Pd. #### Fonts Pd ships with "DejaVu Sans Mono", which is used for the text in canvas windows. -Fonts are sized to fit the hard-coded constraints in Pd Vanilla. This way box +Fonts are sized to fit the hard-coded constraints in Pd Vanilla. This way, box sizes will match as closely as possible across distributions and OSes. These hard-coded sizes are maximum character widths and heights. No font @@ -477,7 +477,7 @@ are intentional, for instance the loose use of function prototypes (see below) and uncast conversions from longer to shorter numerical formats. The code doesn't respect "const" yet. -1.1. Prefixes in structure elements. The names of structure elements always +1.1. Prefixes in structure elements. The names of structure elements always have a K&R-style prefix, as in `((t_atom)x)->a_type`, where the `a_` prefix indicates "atom." This is intended to enhance readability (although the convention arose from a limitation of early C compilers.) Common prefixes are: @@ -498,9 +498,9 @@ argument a pointer named `x`, which is a pointer to a structure suggested by the function prefix; e.g., `canvas_dirty(x, n)` where `x` points to a canvas `(t_canvas *x)`. -1.3. Function Prototypes. Functions which are used in at least two different +1.3. Function Prototypes. Functions that are used in at least two different files (besides where they originate) are prototyped in the appropriate include -file. Functions which are provided in one file and used in one other are +file. Functions that are provided in one file and used in one other are prototyped right where they are used. This is just to keep the size of the ".h" files down for readability's sake. @@ -522,7 +522,7 @@ Lines should fit within 80 spaces. #### 2. Compatibility with Max 2.0. Max patch-level compatibility. "Import" and "Export" functions are -provided which aspire to strict compatibility with 0.26 patches (ISPW version), +provided, which aspire to strict compatibility with 0.26 patches (ISPW version), but which don't get anywhere close to that yet. Where possible, features appearing on the Mac will someday also be provided; for instance, the connect message on the Mac offers segmented patch cords; these will devolve into @@ -532,7 +532,7 @@ Pd, at least at first. #### 3. Source-level Compatibility with Max 3.0. Compatibility with Max 0.26 "externs"-- source-level compatibility. Pd -objects follow the style of 0.26 objects as closely as possible, making +objects follow the style of 0.26 objects as close as possible, making exceptions in cases where the 0.26 model is clearly deficient. These are: 3.1. Anything involving the MacIntosh "Handle" data type is changed to use @@ -601,8 +601,8 @@ PD-GUI: Purpose: a set of functions to communicate with the gui without putting language-specific strings (like tcl) into the C code. The new interface is a step toward separating some (but not all) of the GUI logic out from the C code. -Of course the GUI can still be designed to parse and evaluate incoming messages -as commands. But the idiosyncracies of the GUI toolkit can be limited to +Of course, the GUI can still be designed to parse and evaluate incoming messages +as commands. But the idiosyncrasies of the GUI toolkit can be limited to either the GUI code itself or to a small set of modular wrappers around sys_vgui. @@ -635,10 +635,10 @@ gui_end_vmess(); // terminate the message ``` The above will send a well-formed message to the GUI, where the number of array -elements are limited by the amount of memory available to the GUI. Because of +elements is limited by the amount of memory available to the GUI. Because of the complexity of this approach, it may _only_ be used when it is necessary to -send a variable length message to the GUI. (Some of the current code may -violate this rule, but that can be viewed as a bug which needs to get fixed.) +send a variable-length message to the GUI. (Some of the current code may +violate this rule, but that can be viewed as a bug that needs to get fixed.) The array element functions gui_f, gui_i, and gui_s may only be used inside an array. Arrays may be nested, but this adds complexity and should be avoided if @@ -657,6 +657,6 @@ Engine at the other end of the message. Messages consist of a selector, followed by whitespace, followed by a comman-delimited list of valid Javascript primitives (numbers, strings, and arrays). For the arrays, Javascript's array notation is used. This is a highly idiosyncratic, quick-and-dirty approach. -But the point is that the idiosyncracy exists in a single file of the source +But the point is that the idiosyncrasy exists in a single file of the source code, and can be easily made more modular (or replaced entirely by something else) without affecting _any_ of the rest of the C code.