From 8204f581ab1ba33567047e7d196fea95510944a2 Mon Sep 17 00:00:00 2001
From: Olle Johansson <oej@edvina.net>
Date: Wed, 1 Feb 2006 17:16:08 +0000
Subject: [PATCH] - Adding a doc/00README.1st with an INDEX over README files -
Moving files from / to /doc or /configs - Renaming some documentation files
Thank you for the initiative, manxpower!
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@9046 65c4cc65-6c06-0410-ace0-fbb531ad65f3
---
.../muted.conf.sample | 0
doc/00README.1st | 68 +++++++++++++++++++
doc/{extensions.txt => README.extensions} | 0
HARDWARE => doc/README.hardware | 0
doc/{localchannel.txt => README.localchannel} | 0
doc/{manager.txt => README.manager} | 0
README.fpm => doc/README.musiconhold-fpm | 0
doc/{queuelog.txt => README.queuelog} | 0
SECURITY => doc/README.security | 0
9 files changed, 68 insertions(+)
rename muted.conf.sample => configs/muted.conf.sample (100%)
create mode 100644 doc/00README.1st
rename doc/{extensions.txt => README.extensions} (100%)
rename HARDWARE => doc/README.hardware (100%)
rename doc/{localchannel.txt => README.localchannel} (100%)
rename doc/{manager.txt => README.manager} (100%)
rename README.fpm => doc/README.musiconhold-fpm (100%)
rename doc/{queuelog.txt => README.queuelog} (100%)
rename SECURITY => doc/README.security (100%)
diff --git a/muted.conf.sample b/configs/muted.conf.sample
similarity index 100%
rename from muted.conf.sample
rename to configs/muted.conf.sample
diff --git a/doc/00README.1st b/doc/00README.1st
new file mode 100644
index 0000000000..a530922e63
--- /dev/null
+++ b/doc/00README.1st
@@ -0,0 +1,68 @@
+Files in the /doc directory:
+----------------------------
+In addition to these files, there is a lot of documentation of various
+configuration options in the sample configuration files, in the /configs
+directory of your source code
+
+Start here
+----------
+README.security IMPORTANT INFORMATION ABOUT ASTERISK SECURITY
+README.hardware Hardware supported by Asterisk
+
+Configuration
+-------------
+README.configuration Features in the configuration parser
+README.extensions Basics about the dialplan
+README.extconfig How to use databases for configuration of Asterisk (ARA)
+README.realtime The Asterisk Realtime Architecture - database support
+README.tds Information about the FreeTDS support
+README.ael Information about the Asterisk Extension Language
+
+Misc
+----
+PEERING The General Peering Agreement for Dundi
+README.app_sms How to configure the SMS application
+README.asterisk.conf Documentation of various options in asterisk.conf
+README.callingpres Settings for Caller ID presentation
+README.cdr Call Data Record information
+README.cliprompt How to change the Asterisk CLI prompt
+README.dundi Dundi - a discovery protocol
+README.enum Enum support in Asterisk
+README.ices Integrating ICEcast streaming in Asterisk
+README.jitterbuffer About the IAX2 jitterbuffer implementation
+README.math About the math() application
+README.mp3 About MP3 support in Asterisk
+README.musiconhold-fpm Free Music On Hold music
+README.mysql About MYSQL support in Asterisk
+README.odbcstorage Voicemail storage of messages in UnixODBC
+README.privacy Privacy enhancements in Asterisk
+README.queuelog Agent and queue logging
+README.variables Channel variables
+cdr.txt About CDR storage in various databases (needs update)
+
+Channel drivers
+---------------
+README.misdn
+README.h323 How to compile and configure the H.323 channel
+README.iax About the IAX2 protocol support in Asterisk
+README.localchannel The local channel is a "gosub" in the dialplan
+
+Portability
+-----------
+README.cygwin Compiling Asterisk on CygWin platforms (Windows)
+
+For developers
+--------------
+See http://www.asterisk.org/developers for more information
+
+README.manager About the AMI - Asterisk Manager Interface
+ for third party call control and PBX management
+README.backtrace How to produce a backtrace when Asterisk crashes
+CODING-GUIDELINES Guidelines for developers
+README.channels What is a channel?
+README.externalivr Documentation of the protocol used in externalivr()
+README.linkedlists How to develop linked lists in Asterisk (old)
+iax.txt About the IAX protocol
+apps.txt About application development
+model.txt About the call model in Asterisk (old)
+modules.txt How Asterisk modules work
diff --git a/doc/extensions.txt b/doc/README.extensions
similarity index 100%
rename from doc/extensions.txt
rename to doc/README.extensions
diff --git a/HARDWARE b/doc/README.hardware
similarity index 100%
rename from HARDWARE
rename to doc/README.hardware
diff --git a/doc/localchannel.txt b/doc/README.localchannel
similarity index 100%
rename from doc/localchannel.txt
rename to doc/README.localchannel
diff --git a/doc/manager.txt b/doc/README.manager
similarity index 100%
rename from doc/manager.txt
rename to doc/README.manager
diff --git a/README.fpm b/doc/README.musiconhold-fpm
similarity index 100%
rename from README.fpm
rename to doc/README.musiconhold-fpm
diff --git a/doc/queuelog.txt b/doc/README.queuelog
similarity index 100%
rename from doc/queuelog.txt
rename to doc/README.queuelog
diff --git a/SECURITY b/doc/README.security
similarity index 100%
rename from SECURITY
rename to doc/README.security
--
GitLab