Skip to content

Commit 8570a3d

Browse files
authored
Update README.md
1 parent 7f9db2d commit 8570a3d

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,31 @@
22

33
This is a basic library that allows one to easily create dynamic arrays using a C interface. Actually, it was intended as a DLL plug-in for Zorro Trading Automation. The backend was written in Win32 C++17 using Visual Studio. Its only dependency is the STL library.
44

5+
## What This Library Does
6+
7+
* A dynamic array is basically the equivalent of a C++ std::vector.
8+
* Dynamic arrays can be created, modified, and deleted from memory.
9+
* When you create an array, you define its element size permanently. (For example, sizeof(int) for a dynamic array of ints, or sizeof(STRUCTNAME) for an array of STRUCTNAMEs.)
10+
* You can track an array with a handler, returned from da_new().
11+
* You are advised to delete any dynamic array no longer needed. Simply call da_delete(h), where **h** is the handler.
12+
* You also have the option of clearing **all** dynamic arrays. Simply call da_delete_all(). It will clear all dynamic arrays from the stack, no exceptions.
13+
* All of the remaining functions are simply wrappers for the std::vector library. You can insert elements or arrays of elements at any location in a given dynamic array.
14+
* All of the individual functions are documented in detail in the include/dynamic.h file.
15+
516
## Build Instructions
617

7-
Currently, the library is meant to be built in Visual Studio 2017, though it should not be hard to recycle the core code for UNIX.
18+
Currently, the library is meant to be built in Visual Studio 2017, though it should not be hard to recycle the core code for UNIX, since it only depends on the STL library.
819

920
To build a DLL for Zorro, simply open the solution file, and build in the Release/x86 mode.
21+
22+
## Zorro Installation Instructions
23+
24+
To install DynamicArray in Zorro, the procedure is simple:
25+
1. Build DynamicArray.dll
26+
2. Copy the newly built DynamicArray.dll to your Zorro folder.
27+
3. Copy dynamic.h to your Zorro/include folder.
28+
4. Optionally, copy Zorro/Dynamic.c to your Zorro/Strategy folder. This file demonstrates the functionality of the library.
29+
1030
## License
1131

1232
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

0 commit comments

Comments
 (0)