Updating the main Readme #23
Conversation
| <img src="/images/logo_2020.svg" alt="logo" width="400px"/> | ||
| OpenEEW is an open network of affordable seismic stations distributed around the world that send data to a detection system for earthquake early-warnings (EEWs). | ||
|
|
There was a problem hiding this comment.
Looks like we need a double space here to separate the paragraphs. Or eliminate the linebreak completely and keep it one paragraph.
|
|
||
| ## Learn More | ||
| Please refer to the [Wiki](https://github.com/openeew/openeew/wiki) for more information about Earthquake Early-Warnings, the function, various implementations, and the uniqueness of OpenEEW's open source solution. | ||
|
|
There was a problem hiding this comment.
I think we should update the wiki before linking to it. It's still pretty sparse.
There was a problem hiding this comment.
Agreed. I am back and forth on this issue however - I realize that the wiki belongs to a single repo... so people may not find it easily if it sits in the main repo.
What do you think ? we can use the main repo wiki, or keep a document docs like we have at the moment ?
| - **A detection system running on a server**. You can find instructions for deploying your own [here](https://openeew.com/docs/deploy-detection-docker). | ||
| <img src="/images/openeew-detection.svg" alt="detection" width="200"/> | ||
| ## Get Started | ||
| To participate you need an OpenEEW seismic sensor. You can make your own PCB following [these instructions](https://github.com/openeew/openeew-sensor), or you can buy one at directly from [PCBWay](). | ||
|
|
There was a problem hiding this comment.
ok, lets wait then. will be a few days.
| * **Hardware designs and firmware** so you can build your own IoT-based seismic sensors | ||
| * **Application software** so that users can receive your alerts via mobile apps, devices and more | ||
| * **Guidance to help with your project** including deployment of sensors, installations, and more | ||
|
|
There was a problem hiding this comment.
I think there's still some good context and content in what's removed. Though it could be shortened.
| ## Contributing | ||
| Please read [our contributing guidelines](https://openeew.com/docs/contributing) for details of how you can get involved, and [Code of Conduct](CODE_OF_CONDUCT.md) for information about how to participate. | ||
| ## History | ||
| OpenEEW was initiated by [Grillo](https://grillo.io) in 2019 as a means to share its growing [sensor data](https://registry.opendata.aws/grillo-openeew/) via the AWS Open Data program. In 2020, IBM and Linux Foundation joined to support the open source project and help expand it to include hardware schematics and firmware, as well as code for the detection system, dashboard and alerts. | ||
|
|
There was a problem hiding this comment.
I'd like to keep a link to CFC at the LF somewhere. Maybe turn "The Linux Foundation" into a link back to https://www.linuxfoundation.org/projects/call-for-code/
The existing readme is out of date.
It was written as a list of parts, rather than an introduction to the project and a quick start guide.
The links are in many cases out of date.
The references to the website are removed here because it will be overhauled, and any technical instructions will move the wiki in the master repo folder.