Merge pull request #33 from lemire/dlemire/betterdocsforvs

Better documentation for visual studio

Author: lemire

.github/workflows/visualstudio.yml

@@ -0,0 +1,23 @@
+name: VisualStudio
+
+on: [push, pull_request]
+
+jobs:
+  GeneralTest:
+    runs-on: windows-latest
+
+    steps:
+    
+    - uses: actions/checkout@v2
+
+    - name: Enable Developer Command Prompt
+      uses: ilammy/[email protected]
+    
+    - name: Invoking makefile
+      run: nmake -f .\makefile.vc
+      
+    - name: Run Test Program
+      run: .\unit.exe
+
+    - name: Run Example Program
+      run: .\example.exe

README.md

@@ -39,22 +39,29 @@ Simple demo
 
 Check out example.cpp
 
-You can run it like so:
-
-```
-make example
-./example
-```
+You can run it like so (e.g., under Linux or macOS):
 
 
-Usage
+Usage (Linux, macOS and similar systems)
 ------------------------
 
 ```
 make
 ./unit
 ```
 
+A static library file is built as `libSIMDCompressionAndIntersection.a` which you can use in your
+own projects along with our header files located in the `include` subdirectory.
+
+You may also build and run our example:
+
+
+```
+make example
+./example
+```
+
+
 To run tests, you can do 
 ```
 ./testcodecs
@@ -63,6 +70,24 @@ To run tests, you can do
 (follow the instructions)
 
 
+
+Usage (Windows users)
+------------------------
+
+Windows users wishing to build using Visual Studio should go into a Developer Powershell, which is
+accessible through the menus in the Visual Studio interface, and run the following from the 
+directory of the project:
+
+```
+nmake -f .\makefile.vc
+ .\example.exe
+ .\unit.exe
+ ```
+
+Under Windows, the static library is built as the file `simdcomp_a.lib` which you can use in your
+own projects, along with our header files located in the `include` subdirectory.
+
+
 For a simple C library
 ----------------------
 

makefile.vc

@@ -30,7 +30,7 @@ LDFLAGS = /nologo /LTCG /DYNAMICBASE /incremental:no /debug /opt:ref,icf
 LIB_OBJS = codecfactory.obj bitpacking.obj integratedbitpacking.obj simdbitpacking.obj usimdbitpacking.obj simdintegratedbitpacking.obj intersection.obj varintdecode.obj streamvbyte.obj simdpackedsearch.obj simdpackedselect.obj frameofreference.obj for.obj
 
 
-all: lib unit
+all: lib unit example
 
 $(LIB_OBJS):
 	$(CC) $(INC) $(CFLAGS) /c src/codecfactory.cpp src/bitpacking.cpp src/integratedbitpacking.cpp src/simdbitpacking.cpp src/usimdbitpacking.cpp src/simdintegratedbitpacking.cpp src/intersection.cpp src/varintdecode.c src/streamvbyte.c src/simdpackedsearch.c src/simdpackedselect.c src/frameofreference.cpp src/for.c