Skip to content

Commit

Permalink
windows build (see SheetJS#589 h/t @simon-p-r) [ci skip]
Browse files Browse the repository at this point in the history
  • Loading branch information
SheetJSDev committed Apr 9, 2017
1 parent 51182e5 commit c13170f
Show file tree
Hide file tree
Showing 5 changed files with 59 additions and 0 deletions.
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,8 @@ with a unified JS representation, and ES3/ES5 browser compatibility back to IE6.
* [Tested Environments](#tested-environments)
* [Test Files](#test-files)
- [Contributing](#contributing)
* [OSX/Linux](#osxlinux)
* [Windows](#windows)
- [License](#license)
- [References](#references)
- [Badges](#badges)
Expand Down Expand Up @@ -1406,6 +1408,8 @@ Running `make init` will refresh the `test_files` submodule and get the files.
Due to the precarious nature of the Open Specifications Promise, it is very
important to ensure code is cleanroom. Consult CONTRIBUTING.md

### OSX/Linux

The xlsx.js file is constructed from the files in the `bits` subdirectory. The
build script (run `make`) will concatenate the individual bits to produce the
script. Before submitting a contribution, ensure that running make will produce
Expand All @@ -1421,7 +1425,31 @@ $ git diff xlsx.js
To produce the dist files, run `make dist`. The dist files are updated in each
version release and *should not be committed between versions*.

### Windows

The included `make.cmd` script will build `xlsx.js` from the `bits` directory.
Building is as simple as:

```cmd
> make.cmd
```

To prepare dev environment:

```cmd
> npm install -g mocha
> npm install
> mocha -t 30000
```

The normal approach uses a variety of command line tools to grab the test files.
For windows users, please download the latest version of the test files snapshot
from [github](https://github.com/SheetJS/test_files/releases)

Latest test files snapshot:
<https://github.com/SheetJS/test_files/releases/download/20170409/test_files.zip>

Download and unzip to the `test_files` subdirectory.
## License

Please consult the attached LICENSE file for details. All rights not explicitly
Expand Down
26 changes: 26 additions & 0 deletions docbits/95_contrib.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
Due to the precarious nature of the Open Specifications Promise, it is very
important to ensure code is cleanroom. Consult CONTRIBUTING.md

### OSX/Linux

The xlsx.js file is constructed from the files in the `bits` subdirectory. The
build script (run `make`) will concatenate the individual bits to produce the
script. Before submitting a contribution, ensure that running make will produce
Expand All @@ -18,4 +20,28 @@ $ git diff xlsx.js
To produce the dist files, run `make dist`. The dist files are updated in each
version release and *should not be committed between versions*.

### Windows

The included `make.cmd` script will build `xlsx.js` from the `bits` directory.
Building is as simple as:

```cmd
> make.cmd
```

To prepare dev environment:

```cmd
> npm install -g mocha
> npm install
> mocha -t 30000
```

The normal approach uses a variety of command line tools to grab the test files.
For windows users, please download the latest version of the test files snapshot
from [github](https://github.com/SheetJS/test_files/releases)

Latest test files snapshot:
<https://github.com/SheetJS/test_files/releases/download/20170409/test_files.zip>

Download and unzip to the `test_files` subdirectory.
2 changes: 2 additions & 0 deletions make.cmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
type bits\* > xlsx.flow.js
node misc\strip_flow.js > xlsx.js
2 changes: 2 additions & 0 deletions misc/docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,8 @@
* [Tested Environments](README.md#tested-environments)
* [Test Files](README.md#test-files)
- [Contributing](README.md#contributing)
* [OSX/Linux](README.md#osxlinux)
* [Windows](README.md#windows)
- [License](README.md#license)
- [References](README.md#references)
- [Badges](README.md#badges)
1 change: 1 addition & 0 deletions misc/strip_flow.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
process.stdout.write(require("fs").readFileSync("xlsx.flow.js","utf8").replace(/^[ \t]*\/\*[:#][^*]*\*\/\s*(\n)?/gm,"").replace(/\/\*[:#][^*]*\*\//gm,""))

0 comments on commit c13170f

Please sign in to comment.