From f67d7892a86d348fae8ffe4293a613652c44579f Mon Sep 17 00:00:00 2001 From: Matteo Cypriani Date: Thu, 3 Nov 2016 00:13:04 -0400 Subject: [PATCH] Add README.md to accommodate Gogs README.md is an excerpt of doc/owlps.t2t, and integrates the information from the former README.t2t, which was deleted. --- README.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.t2t | 25 ------------------------- 2 files changed, 54 insertions(+), 25 deletions(-) create mode 100644 README.md delete mode 100644 README.t2t diff --git a/README.md b/README.md new file mode 100644 index 0000000..12c9ede --- /dev/null +++ b/README.md @@ -0,0 +1,54 @@ +# Owl Positioning System + +**OwlPS** (_Owl Positioning System_) is a positioning (localization) system +based on the IEEE 802.11 radio network (Wi-Fi), targeting mainly indoor +environments. It uses an infrastructure-centred architecture, which means the +infrastructure does the measurements and computes the mobile terminals' +positions, rather than the terminals computing their own positions (as it is +the case for instance with the GPS). + +OwlPS implements various positioning techniques and algorithms based on the +radio signal strength. It features a self-calibration (or autocalibration) +mechanism that avoids the time-consuming manual fingerprinting phase and allows +considering dynamic changes of the environment (human, climatic, etc.) when +computing the location of mobile terminals. + +**This presentation is an excerpt of `doc/owlps.t2t`. Please refer to this file +for a more in-depth introduction to OwlPS.** + +## News + +OwlPS is not currently actively maintained, as I'm not working on indoor +positioning at the moment, but I'll happily consider any contribution (or +job offer). + +The `CHANGELOG` file lists the changes that occurred in OwlPS, version by +version, since its early stages. + +## Contribute + +If you would like to contribute to OwlPS, you can: + + * use it, test it, and report suggestions and bugs on the forge: + + + * get the latest development code, add functionalities and send me pull + requests by email or on the forge: + +If you're looking for ideas, the `TODO.t2t` file could be a good start. + +## Installation + +For a guide to installing OwlPS, please consult `INSTALL.t2t`. + +## License + +OwlPS is free software, released under the terms of the CeCILL license (GNU +GPL-compatible). For more detail, please consult `COPYRIGHT.t2t`. + +## Note on the t2t file extension + +Most of the documentation in this repository is provided as text files in the +**txt2tags** format (`*.t2t` files). You can convert them to various formats +(HTML, man pages, etc.) using the [txt2tags](http://txt2tags.org/) utility; if +you mind the markup tags, you can even strip them using the `txt` output. diff --git a/README.t2t b/README.t2t deleted file mode 100644 index 0565846..0000000 --- a/README.t2t +++ /dev/null @@ -1,25 +0,0 @@ -This is the OwlPS (Owl Positioning System) software distribution. - - -For an introduction to OwlPS, please consult ``doc/owlps.t2t``, which is -the documentation's entry point. - -For copyright and license informations, please consult -``COPYRIGHT.t2t``. - -For a guide to installing OwlPS, please consult ``INSTALL.t2t``. - -The file ``CHANGELOG`` lists the changes occured in OwlPS, version by -version, since its early stages. - -Finally, the file ``TODO.t2t`` is a list of potential work to do on the -system. If you are willing to contribute and are looking for ideas, that -can be a good start. - - -: Note on the t2t file extension - The documentation is provided as text files in the txt2tags format - (file extension ``*.t2t``). You can convert them to various formats - (HTML, man pages, etc.) using the ``txt2tags`` utility; if you mind - the markup tags, you can even strip them using the ``txt`` output. - ``txt2tags`` is distributed at http://txt2tags.org/