summaryrefslogtreecommitdiff
path: root/ReadMe.txt
diff options
context:
space:
mode:
authorPatrick Elsen <pelsen@xfbs.net>2017-07-11 13:38:06 +0200
committerPatrick Elsen <pelsen@xfbs.net>2017-07-11 13:38:06 +0200
commitf1ed8b34e1fdacbd38bd2716242adf707f20a9e0 (patch)
treeaf45df4dc64d51b86d38c7c205689ef0ac1dfa0e /ReadMe.txt
parentf48d99c39011ad10f8a4d09a7fd660dcfc0e4a85 (diff)
downloadlibical-git-f1ed8b34e1fdacbd38bd2716242adf707f20a9e0.tar.gz
ReadMe.txt - restructures to make documentation & building section more accessible
Diffstat (limited to 'ReadMe.txt')
-rw-r--r--ReadMe.txt37
1 files changed, 18 insertions, 19 deletions
diff --git a/ReadMe.txt b/ReadMe.txt
index 091ba331..0d085b69 100644
--- a/ReadMe.txt
+++ b/ReadMe.txt
@@ -25,24 +25,37 @@ iCalendar extensions in [RFC6638][]; and some of [RFC6047][].
## License
The code and datafiles in this distribution are licensed under the
-Mozilla Public License (MPL) v2.0. See http://www.mozilla.org/MPL
-for a copy of the license.
+Mozilla Public License (MPL) v2.0. See <http://www.mozilla.org/MPL>
+for a copy of this license.
Alternately, you may use libical under the terms of the GNU Lesser
-General Public License (LGPL) v2.1. See http://www.gnu.org/licenses/lgpl-2.1.txt
-for a copy of the license.
+General Public License (LGPL) v2.1. See <http://www.gnu.org/licenses/lgpl-2.1.txt>
+for a copy of this license.
This dual license ensures that the library can be incorporated into
both proprietary code and GPL'd programs, and will benefit from improvements
made by programmers in both realms. I will only accept changes into
my version of the library if they are similarly dual-licensed.
+## Building
+
+See the top-level [Install.txt](Install.txt) file.
+
+## Documentation
+
+There is rudimentary, unfinished documentation in the `doc/` directory,
+see [UsingLibical.md](doc/UsingLibical.md)
+and annotated examples in `examples/` and the test code in `src/test/`.
+
+Additionally, progress is underway to add Doxygen documentation
+for libical, which is available [here](http://libical.github.io/libical/apidocs/index.html)
## Acknowledgments
Portions of this distribution are (C) Copyright 1996 Apple Computer,
Inc., AT&T Corp., International Business Machines Corporation and
-Siemens Rolm Communications Inc. See src/libicalvcal/README.TXT for
+Siemens Rolm Communications Inc. See
+[src/libicalvcal/README.TXT](src/libicalvcal/README.txt) for
details.
## Get Involved
@@ -57,17 +70,3 @@ For general discussions about libical and related projects
Report bugs to our issue tracker at
<https://github.com/libical/libical/issues>
-
-
-## Building the library
-
-See the top-level [Install.txt](Install.txt) file.
-
-## Using the Library
-
-There is rudimentary, unfinished documentation in the `doc/` directory,
-see [UsingLibical.md](doc/UsingLibical.md)
-and annotated examples in `examples/` and the test code in `src/test/`.
-
-Additionally, progress is underway to add Doxygen documentation
-for libical, which is available [here](http://libical.github.io/libical/apidocs/index.html)