Skip to content

Commit aa588ff

Browse files
committed
Readme completion.
1 parent e644dd5 commit aa588ff

File tree

1 file changed

+31
-8
lines changed

1 file changed

+31
-8
lines changed

README.md

Lines changed: 31 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,23 @@ For more details on the inner workins of this program we would like to redirect
1818

1919
The program has all its interaction with the console, it is advised to call the application's .exe file through a console or batch file as well for easier usage. Some premade batch files are present in the application "Prepared Statements" folder and these also show insights in how you can configure your personal call to the program. If this is not clear than you can call the application with the help verb to get more information on how it can be used. "ShapeDatabase.exe help"
2020

21+
If you would like to query shapes which are not in the database then you would need to put these Shapes (with possibly their class if you want evaluations) into the Content/Query folder. You can define a class of a Shape by putting it into a folder with that name.
22+
23+
### Commands
24+
25+
- Clean: Delete all cached data for a clean restart.
26+
- View: View the different shapes in the system.
27+
- Refine: Refine the provided shapes and store them in the system.
28+
- Measure: Calculate shape metrics, such as the vertex & face count for all the current shapes.
29+
- Feature: Calculate feature vectors for all the current shapes.
30+
- Query: Compare existing shapes with query shapes to find the most similar.
31+
- Evaluate: Evaluate the precision of queried results.
32+
- Help: Display informative text about different commands and their usage.
33+
2134
### Prerequisites
2235

2336
A good understanding of C# and Visual Studio is required to code for this program.
37+
This program has been written with Visual Studio 2019 and no guarantee can be made with how well it works on previous versions.
2438

2539
### Installing
2640

@@ -29,13 +43,13 @@ There are 2 ways to use the application: One is to go to the releases section an
2943
## Build With
3044

3145
This program wasn't possible without the following public packages from authors around Github.
32-
- *Accord.Net:* for their statistical data processing, in particular their PCA system.
33-
- *Geometry3Sharp:* for their 3D mesh computational algorithms.
34-
- *HNSW.Net:* for their approximate neirest neighbour search program.
35-
- *OpenTK:* for their visualisation code in C#.
36-
- *CommandLineParser:* for easier console usage.
37-
- *CsvHelper:* for their Csv reader and writers.
38-
- *IniParser:* for their ini readers and writers.
46+
- *[Accord.Net]* for their statistical data processing, in particular their PCA system.
47+
- *[Geometry3Sharp]* for their 3D mesh computational algorithms.
48+
- *[HNSW.Net]* for their approximate neirest neighbour search program.
49+
- *[OpenTK]* for their visualisation code in C#.
50+
- *[CommandLineParser]* for easier console usage.
51+
- *[CsvHelper]* for their Csv reader and writers.
52+
- *[IniParser]* for their ini readers and writers.
3953

4054
## Contributors / Authors
4155

@@ -45,4 +59,13 @@ The people who made this original repository and brought this code to the world
4559

4660
## Acknolwedgements
4761

48-
And finally we would like to thank all the public library authors who made it possible for us to construct this program, the C# team for this programming language and our professor prof. dr. Alexandru C. Telea for teaching us how to design such an extensive system.
62+
And finally we would like to thank all the public library authors who made it possible for us to construct this program, the C# team for this programming language and our professor prof. dr. Alexandru C. Telea for teaching us how to design such an extensive system.
63+
64+
65+
[Accord.Net]:http://accord-framework.net/
66+
[Geometry3Sharp]:https://github.com/gradientspace/geometry3Sharp
67+
[HNSW.Net]:https://github.com/microsoft/HNSW.Net
68+
[OpenTK]:https://github.com/opentk/opentk
69+
[CommandLineParser]:https://github.com/commandlineparser/commandline
70+
[CsvHelper]:https://github.com/JoshClose/CsvHelper
71+
[IniParser]:https://github.com/rickyah/ini-parser

0 commit comments

Comments
 (0)