ref: ede63e37a9666cc3ab2632f3fed6710bcee38da1
parent: fe030d911f432b6bb7ba796ee4e5862ea2d236c5
author: Paul Brossier <piem@piem.org>
date: Mon Apr 10 06:08:53 EDT 2017
README.md: less legal, more help
--- a/README.md
+++ b/README.md
@@ -41,8 +41,8 @@
please see the file [`python/README.md`](python/README.md) and the
[manual](https://aubio.org/manual/latest/) .
-Examples tools
---------------
+Tools
+-----
The python module comes with the following command line tools:
@@ -59,6 +59,12 @@
- `aubionotes` emits midi-like notes, with an onset, a pitch, and a duration
- `aubioquiet` extracts quiet and loud regions
+Documentation
+-------------
+
+ - [manual](https://aubio.org/manual/latest/), generated with sphinx
+ - [developer documentation](https://aubio.org/doc/latest/), generated with Doxygen
+
The latest version of the documentation can be found at:
https://aubio.org/documentation
@@ -87,26 +93,21 @@
page](https://aubio.org/manual/latest/about.html) in [aubio
manual](https://aubio.org/manual/latest/).
-Contact Info and Mailing List
------------------------------
+Homepage
+--------
The home page of this project can be found at: https://aubio.org/
-Questions, comments, suggestions, and contributions are welcome. Use the
-mailing list: <aubio-user@aubio.org>.
+License
+-------
-To subscribe to the list, use the mailman form:
-https://lists.aubio.org/listinfo/aubio-user/
-
-Alternatively, feel free to contact directly the author.
-
-
-Copyright and License Information
----------------------------------
-
-Copyright (C) 2003-2017 Paul Brossier <piem@aubio.org>
-
aubio is free software: you can redistribute it and/or modify it under the
terms of the GNU General Public License as published by the Free Software
Foundation, either version 3 of the License, or (at your option) any later
version.
+
+Contributing
+------------
+
+Patches are welcome: please fork the latest git repository and create a feature
+branch. Submitted requests should pass all continuous integration tests.