From a410eef63b5992e4cab4964400207867b2c2e589 Mon Sep 17 00:00:00 2001 From: Hugo Gomes Date: Mon, 4 Dec 2023 15:38:00 +0000 Subject: [PATCH] Update README.md --- README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 72b57b1..4864bb9 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,22 @@ # [Colony Gateway (NPAPI Plugin)](http://getcolony.com) -NPAPI based plugin that provides a series of native features like: +NPAPI-based plugin that provides a series of native features like: * Printing using direct access to the printing infra-structure of the operative system -* Creation of native based GUI elements +* Creation of native-based GUI elements -The current implementation supports only x86/x64 architectures and Windows, Linux and Mac OS X. +The current implementation supports only x86/x64 architectures and Windows, Linux, and Mac OS X. ## Building -In order to build both the CRX (Goolgle Chrome) and the XPI (Mozilla Firefox) files for the plugin +To build both the CRX (Google Chrome) and the XPI (Mozilla Firefox) files for the plugin one should use the scripts created for such effect under the [scripts](scripts) directory. The automated process assumes the Windows build process using the Visual Studio IDE. ### Windows Use Visual Studio 2008 Express for compilation with no additional dependencies. The build process should -create the plugins files in the output. +create the plugin files in the output. ### Mac OS X @@ -24,23 +24,23 @@ Download the [Gecko SDK 1.9 32 bit](https://developer.mozilla.org/en-US/docs/Gec website. Use the `/Library/Internet Plug-Ins/` directory to test the plugin while the proper extension package file -is not created. Remenber to rename the `*.bundle` package into an `*.plugin` based package. +is not created. Remember to rename the `*.bundle` package into an `*.plugin` based package. ### Linux Use the `/usr/lib/mozilla/plugins/` directory to test the `*.so` based plugin file for development purposes. -[Mozilla Firefox](http://www.mozilla.org) should be the primary browser for the debugging of the NPAPI based plugin. +[Mozilla Firefox](http://www.mozilla.org) should be the primary browser for the debugging of the NPAPI-based plugin. ### Python -It's also possible to build a Python module that exports the functionality present in the NPAPI Plugin for -such run the python script as `python setup.py install` under an UNIX based machine. +It's also possible to build a Python module that exports the functionality in the NPAPI Plugin for +running the python script as `python setup.py install` under an UNIX-based machine. ## Packaging ### Google Chrome -Create a package file that contains the references to the complete set of plugins files for the various +Create a package file containing references to the complete set of plugin files for the various platforms as defined in the `src/colony_npapi/descriptors/manifest_u.json` file. ```javascript @@ -56,7 +56,7 @@ platforms as defined in the `src/colony_npapi/descriptors/manifest_u.json` file. }] ``` -Copy the proeper files (`npcolony.dll`, `libnpcolony.so` and `npcolony.plugin`) into the proper release directory +Copy the proper files (`npcolony.dll`, `libnpcolony.so` and `npcolony.plugin`) into the proper release directory and then run the `make_all build` script to create the target files (eg: cbx and xpi). ```bash