Skip to content

Commit 80ef4a7

Browse files
authored
Update README.md
1 parent 20dd991 commit 80ef4a7

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

README.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,15 @@
11
# 3rd year Dissertation Project - University of Manchester
22

3-
The beginning of a C JNI Agent which can capture recursively the values of objects inside the methods on a stack-trace
3+
The commencement of a C JNI Agent, designed to recursively capture the values of objects within methods on a stack trace.
44

5-
To build the C part you need to install the libxml2 library and Jansson and crypto and openssl.
5+
To use, it is necessary to install the libxml2 library, as well as Jansson, crypto, and openssl.
66

7-
The resulting library files can be attached using the -agentpath in the java command.
7+
The resulting library files can be incorporated using the -agentpath flag in the java command.
88

9-
Communicates with an elementary Scala Spray server recording values in MongoDB (configure src/main/resources/application.conf from sample, build and run with sbt run)
9+
This agent interacts with a basic Scala Spray server, which records the captured values in MongoDB. To configure the server, modify the src/main/resources/application.conf file accordingly, then build and execute it using sbt run.
1010

11-
Uses a FuelPHP dashboard which communicated with the Scala Spray Server to show results of analysis (do a composer install)
11+
Additionally, a FuelPHP dashboard is utilized, which communicates with the Scala Spray server to present the analysis results. Ensure you perform a composer install to set it up.
1212

13-
No stable, not secure or optimised.
13+
It is important to note that this implementation is not stable, secure, or optimized, as it serves as a minimum viable product (MVP). However, you can extract relevant code snippets from it, particularly those demonstrating communication with the JNE.
1414

15-
This is an MVP from which you could use code-bits for now, especially on how to communicate with the JNE.
16-
17-
This was an university experimental project.
15+
Please bear in mind that this project was an experimental endeavor conducted at the university level.

0 commit comments

Comments
 (0)