File tree Expand file tree Collapse file tree 1 file changed +16
-11
lines changed
Expand file tree Collapse file tree 1 file changed +16
-11
lines changed Original file line number Diff line number Diff line change @@ -11,8 +11,9 @@ A Fast SymSpell v6.5 port for python written in C++ using pybind11.
1111pip install SymSpellCppPy
1212```
1313
14- ## Usage
15- [ Examples] ( https://symspellcpppy.readthedocs.io/en/latest/Examples.html )
14+ ## Documentation
15+ * Check [ examples] ( https://symspellcpppy.readthedocs.io/en/latest/Examples.html ) for provided usage.
16+ * Check [ api docs] ( https://symspellcpppy.readthedocs.io/en/latest/SymSpellCppPy.html#pybind11-binding-for-symspellpy ) for detailed API documentation.
1617
1718## Benchmark Results
1819``` shell script
@@ -30,25 +31,29 @@ cmake .. -DCMAKE_BUILD_TYPE=Release
3031make -j$( nproc)
3132```
3233
33- ## Testing
34- For detailed list of command line test flags please refer to [ Catch 2 Docs] ( https://github.com/catchorg/Catch2/blob/master/docs/command-line.md#top )
35- ``` shell script
36- cd build
37- ./Catch2Test -s
38- ```
34+ ### Testing
35+
3936
40- ## Python Bindings
37+ ### Python Bindings
4138
42- ### Building
39+ ### Build
4340``` shell script
4441python3 setup.py build
4542```
4643
47- ### Testing
44+ ### Test
45+ #### Python tests
4846``` shell script
4947python3 setup.py test
5048```
5149
50+ #### C++ tests
51+ For detailed list of command line test flags please refer to [ Catch 2 Docs] ( https://github.com/catchorg/Catch2/blob/master/docs/command-line.md#top )
52+ ``` shell script
53+ cd build
54+ ./Catch2Test -s
55+ ```
56+
5257## Acknowledgements
5358* [ SymSpell by @wolfgarbe ] ( https://github.com/wolfgarbe/SymSpell )
5459* [ SymspellCPP by @AtheS21 ] ( https://github.com/AtheS21/SymspellCPP )
You can’t perform that action at this time.
0 commit comments