From 8ef03cf58d00dc2da90cc2b2f157287b0dc067b4 Mon Sep 17 00:00:00 2001 From: Steve Karg Date: Thu, 12 Mar 2020 20:45:37 -0500 Subject: [PATCH] Update README.md --- README.md | 78 +++++++++++++++++++++++++++++++++++++------------------ 1 file changed, 53 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 9c5a2b6e..d82c0b35 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,7 @@ accordance with section (3) of the GNU General Public License." The code is written in C for portability, and includes unit tests (PC based unit tests). Since the code is designed to be portable, it compiles with GCC as -well as other compilers, such as Borland C++ or MicroChip C18. +well as other compilers, such as Clang or IAR. The BACnet protocol is an ASHRAE/ANSI/ISO standard, so this library adheres to that standard. BACnet has no royalties or licensing restrictions, and @@ -53,12 +53,19 @@ registration for a BACnet vendor ID is free. What the code does ------------------ -The stack comes with unit tests that can be run in a command shell using the -test.sh script. The unit tests can also be run using individual .mak files. -They were tested on a Linux PC. +For an overview of this library architecture and how to use it, see +https://sourceforge.net/p/bacnet/src/ci/master/tree/doc/README.developer + +This stack includes unit tests that can be run using the Makefile in the +project root directory "make test". +The unit tests can also be run using individual make invocations. +The unit tests run a PC and continue to do so with +every commit within the Continuous Integration environment. + +The BACnet stack was functionally tested using a variety of tools +as well as various controllers and workstations. It has been included +in many products that successfully completed BTL testing. -The BACnet stack was functionally tested using VTS (Visual Test Shell), another -project hosted on SourceForge, as well as various controllers and workstations. Using the Makefile in the project root directory, a dozen sample applications are created that run under Windows or Linux. They use the BACnet/IP datalink layer for communication by default, but could be compiled to use BACnet @@ -67,25 +74,28 @@ Ethernet, ARCNET, or MS/TP. Linux/Unix/Cygwin $ make clean all -Windows -c:\> build.bat +Windows MinGW Bash +$ make win32 + +Windows Command Line +c:> build.bat The BACnet stack can be compiled by a variety of compilers. The most common -free compiler is GCC (MinGW under Windows). The makefiles use GCC by -default. Makefile.b32 are written for the Borland C++ 5.5 compiler, and -projects are also included for Microsoft Visual Studio and Code::Blocks. +free compiler is GCC (or MinGW under Windows). The makefiles use GCC by +default. The demo applications are all client applications that provide one main BACnet -service, except the one server application. Each application will accept -command line parameters, and prints the output to stdout or stderr. The client -applications are command line based and can be used in scripts or for -troubleshooting. The demo applications make use of environment variables to +service, except the one server application and one gateway application. +Each application will accept command line parameters, and prints the output to +stdout or stderr. The client applications are command line based and can +be used in scripts or for troubleshooting. +The demo applications make use of environment variables to setup the network options. See each individual demo for the options. -There are also projects in the ports/ directory for ARM7, AVR, RTOS-32, -and PIC. Each of those projects has a demo application for specific hardware. -In the case of the ARM7 and AVR, the makefile works with GCC compilers and -there are project files for IAR Embedded Workbench. +There are also projects in the ports/ directory for ARM7, AVR, RTOS-32, PIC, +and others. Each of those projects has a demo application for specific hardware. +In the case of the ARM7 and AVR, their makefile works with GCC compilers and +there are project files for IAR Embedded Workbench and Rowley Crossworks for ARM. Project Documentation --------------------- @@ -93,19 +103,37 @@ Project Documentation The project documentation is in the doc/ directory. Similar documents are on the project website at . -Project Mailing List --------------------- +Project Mailing List and Help +----------------------------- -If you want to help this project, or have a problem getting it to work for +If you want to contribute to this project and have some C coding skills, +join us via https://github.com/bacnet-stack/bacnet-stack/ +or via https://sourceforge.net/p/bacnet/src/ and create a +fork or branch, and eventually a pull request to have +your code considered for inclusion. + +If you find a bug in this project, please tell us about it at +https://sourceforge.net/p/bacnet/bugs/ +or +https://github.com/bacnet-stack/bacnet-stack/issues + +If you have a support request, you can post it at +https://sourceforge.net/p/bacnet/support-requests/ + +If you have a feature request, you can post it at +https://sourceforge.net/p/bacnet/feature-requests/ + +If you have a problem getting this library to work for your device, or have a BACnet question, join the developers mailing list at: http://lists.sourceforge.net/mailman/listinfo/bacnet-developers +or post the question to the Open Discussion, Developers, or Help forums at +https://sourceforge.net/p/bacnet/discussion/ -I hope that you get your BACnet Device working! If not, join us on the -mailing list and we can help. +I hope that you get your BACnet Device working! Steve Karg, Birmingham, Alabama USA skarg@users.sourceforge.net ASHRAE® and BACnet® are registered trademarks of the American Society of Heating, Refrigerating and Air-Conditioning Engineers, Inc. -1791 Tullie Circle NE, Atlanta, GA 30329. \ No newline at end of file +1791 Tullie Circle NE, Atlanta, GA 30329.