Clean up/harmonize READMEs (#55)

Author: ihnorton

README.md

@@ -4,7 +4,7 @@
 
 # TileDB Vector Search
 
-*TileDB-Vector-Search* is a C++ library and Python interface to Vector Search built onto of the [TileDB Storage Engine](https://github.com/TileDB-Inc/TileDB).
+*TileDB-Vector-Search* is a C++ library and Python API for vector search built on top of the [TileDB Storage Engine](https://github.com/TileDB-Inc/TileDB).
 
 # Quick Links
 
@@ -29,6 +29,8 @@ conda install -c tiledb tiledb-vector-search
 
 # Contributing
 
-We welcome contributions, please see [`CONTRIBUTING.md`](CONTRIBUTING.md) for suggestions and
-development-build instructions. For larger features, please open an issue to discuss goals and
-approach in order to ensure a smooth PR integration and review process.
+We welcome contributions. Please see [`Building`](Building.md) for
+development-build instructions. For large new
+features, please open an issue to discuss goals and approach in order
+to ensure a smooth PR integration and review process. All contributions
+must be licensed under the repository's [MIT License](../LICENSE).

apis/python/README.md

@@ -11,10 +11,10 @@
 
 ## Build and install with pip
 
-(TODO: DOES NOT WORK YET)
+See `setup.py` for supported configuration overrides, including the libtiledb path.
 
 ```
-CMAKE_ARGS="-DTileDB_DIR=/Users/inorton/work/bld/TileDB-2.15/rel/dist/lib/cmake/TileDB" pip install -e
+pip install -e .
 ```
 
 ## Direct build, then export PYTHONPATH
@@ -53,59 +53,4 @@ export PYTHONPATH= ~/work/bld/fvp-build/python
 
 ```
 import tiledbvspy
-```
-
-# ====
-
-X. Usage example
-
-```
-In [1]: import tiledbvspy
-
-In [2]: v = tiledbvspy.get_v()
-
-In [3]: v_np = np.array(v)
----------------------------------------------------------------------------
-NameError                                 Traceback (most recent call last)
-Input In [3], in <cell line: 1>()
-----> 1 v_np = np.array(v)
-
-NameError: name 'np' is not defined
-
-In [4]: import tiledbvspy, numpy as np
-
-In [5]: v_np = np.array(v)
-
-In [6]: v_np
-Out[6]: array([1., 2., 3., 4., 5., 6., 7.], dtype=float32)
-
-In [7]: v_np[1] = 10
-
-In [8]: v
-Out[8]: <tiledbvspy.Vector_f32 at 0x103030db0>
-
-In [9]: v[1]
-Out[9]: 2.0
-
-In [10]: v[0]
-Out[10]: 1.0
-
-In [11]: v[2]
-Out[11]: 3.0
-
-In [12]: v[3]
-Out[12]: 4.0
-
-In [13]: v_np_view = np.array(v, copy=False)
-
-In [14]: v_np_view
-Out[14]: array([1., 2., 3., 4., 5., 6., 7.], dtype=float32)
-
-In [15]: v_np_view[2] = 12.5
-
-In [16]: v_np_view
-Out[16]: array([ 1. ,  2. , 12.5,  4. ,  5. ,  6. ,  7. ], dtype=float32)
-
-In [17]: v[2]
-Out[17]: 12.5 # original data modified
-```
+```

documentation/index.md

@@ -9,7 +9,7 @@
 # Quick Links
 
 * [Build Instructions](https://tiledb-inc.github.io/TileDB-Vector-Search/documentation/Building.html)
-* [TileDB Documentation](https://tiledb-inc.github.io/TileDB-Vector-Search/)
+* [Documentation](https://tiledb-inc.github.io/TileDB-Vector-Search/)
 * [Python API reference](https://tiledb-inc.github.io/TileDB-Vector-Search/documentation/reference/)
 
 # Quick Installation