update README.md

README.md

@@ -1,37 +1,66 @@
 # SeisIO
 A minimalist, platform-agnostic package for working with univariate geophysical data.
 
+## Documentation
+http://seisio.readthedocs.org
+
+## Functionality
+Includes web clients, readers for several data formats, and writers for SAC and a native SeisIO format. Utility functions allow time synchronization, data merging, and padding time gaps.
+
+| **Web clients** | **Readable File Formats** |
+|:----------------|:--------------------------|
+| SeedLink | mini-SEED |
+| FDSN (data, event, station)| SAC |
+|  IRIS (timeeseries) | SEG Y (rev 0, rev 1, PASSCAL/NMT) |
+|| Win_32 |
+|| UW |
+
+### Julia v0.7.0
 | **Build Status: Julia v0.7.0** |
 |:-------------------------------------------------------------------------------:|
 | [![](https://travis-ci.org/jpjones76/SeisIO.jl.svg?branch=master)](https://travis-ci.org/jpjones76/SeisIO.jl) [![Build status](https://ci.appveyor.com/api/projects/status/ocilv0u1sy41m934?svg=true)](https://ci.appveyor.com/project/jpjones76/seisio-jl) |
 
-# Documentation
-http://seisio.readthedocs.org
-
-# Current Functionality
-SeisIO presently includes three web clients, readers for several data formats, and writers for SAC and a native SeisIO format. Utility functions allow synchronization, seamless data merging, and padding time gaps.
+### Julia v1.0.0
+* SeisIO runs after minor manual fixes to some dependencies. See below.
 
-## Web clients
-* SeedLink
-* FDSN (data, event, and station queries)
-* IRIS timeseries
+## Known Issues (2018-08-12)
+* Rarely, `SeedLink!` may cause a Julia session to hang when a connection fails to initialize.
+* IN Julia v0.7, LightXML and Blosc generate "deprecated syntax" warnings.
+* SeisIO has broken dependencies in Julia v1.0.
 
-## Readable File Formats
-* SAC
-* miniSEED
-* SEG Y
-  + rev 0
-  + rev 1
-  + PASSCAL/NMT single-channel files
-* Win32
-* UW
+### Building for Julia 1.0.0
+Four dependencies must be modified for SeisIO to work in Julia 1.0: DSP, Blosc, and CMake/CMakeWrapper. If you'd rather do this yourself than wait for the official fixes, it takes very little time:
 
-# Known Issues (2018-08-10)
-* Rarely, `SeedLink!` may cause a Julia session to hang when a connection fails to initialize.
-* Required packages LightXML and Blosc both generate "Deprecated syntax" warnings.
+* Add CMake.jl and CMakeWrapper.jl directly from their GitHub sites:
+  ```
+  ]
+  (v1.0) pkg> add https://github.com/JuliaPackaging/CMake.jl
+  (v1.0) pkg> add https://github.com/JuliaPackaging/CMakeWrapper.jl
+  (v1.0) pkg> build CMake
+  (v1.0) pkg> build CMakeWrapper
+  ```
+* In (src)/packages/Blosc/src/Blosc.jl, replace both calls to 'isbits' with 'isbitstype'
+  + After modification, rebuild Blosc:
+  ```
+  ]
+  (v1.0) pkg> build Blosc
+  ```
+* In (src)/packages/DSP/src/periodograms.jl and util.jl, update the DSP iterator syntax:
+  + Refer to the pull request at  https://github.com/JuliaDSP/DSP.jl/pull/220/commits/de6157495772588b434bb24b2e7f6612bd0d6161
+  + In each of the above two .jl files, replace the text in *red* in the pull request with the text in *green*
+  + After saving your modifications, rebuild DSP:
+  ```
+  ]
+  (v1.0) pkg> build Blosc
+  ```
+* Compile and test SeisIO:
+  ```
+  ]
+  add SeisIO; precompile; test SeisIO
+  ```
 
-# Changelog
-## 2018-08-10
+## Changelog
+### 2018-08-10
 * Updated for Julia 0.7. Testing for 1.0.
 * `wseis` has changed:
   + New syntax: `wseis(filename, objects)`
@@ -46,23 +75,10 @@ SeisIO presently includes three web clients, readers for several data formats, a
   + Issues with `wseis` and `SeisHdr` objects should be corrected.
   + Improved partial string matches for channel names and IDs.
 
-## 2017-08-07
-* Improved `note!` functionality and logging of basic processing operations.
-* New function: `clear_notes!` can delete notes for a given channel number or string ID.
-* Minor bug fix for `readuw`
-* Fixed a bug in how `ungap!` handled very short data segments (N < 20 samples).
-
-## 2017-08-04
-* Fixed a mini-SEED bug introduced 2017-07-16 where some IDs were set incorrectly.
-* Internal function `tzcorr()` moved to PlotSeis.
-* Added functions:
-  + `env, env!`: Convert time-series data to envelopes (still in testing; gapped data not yet fully supported)
-  + `del_sta!`: Delete all channels matching a station string (2nd part of ID)
-
-# Acknowledgements
-miniSEED routines are based on rdmseed.m for Matlab by Francois Beauducel, Institut de Physique du Globe de Paris (France). Many thanks to Robert Casey and Chad Trabant (IRIS, USA) for discussions of IRIS web services, and Douglas Neuhauser (UC Berkeley Seismological Laboratory, USA) for discussions of the SAC data format.
+## Acknowledgements
+miniSEED routines are based on rdmseed.m for Matlab by Francois Beauducel, Institut de Physique du Globe de Paris (France). Many thanks to Robert Casey and Chad Trabant (IRIS, USA) for discussions of IRIS web services;  Douglas Neuhauser (UC Berkeley Seismological Laboratory, USA) for discussions of the SAC data format; and Roberto Carniel (Universita di Udine, Italy) for assistance with testing.
 
-# References
+## References
 1. IRIS (2010), SEED Reference Manual: SEED Format Version 2.4, May 2010, IFDSN/IRIS/USGS, http://www.iris.edu
 2. Trabant C. (2010), libmseed: the Mini-SEED library, IRIS DMC.
 3. Steim J.M. (1994), 'Steim' Compression, Quanterra Inc.