aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorDavid Reyna <David.Reyna@windriver.com>2018-05-17 19:39:24 -0700
committerDavid Reyna <David.Reyna@windriver.com>2018-05-17 19:39:24 -0700
commitfba5cbb6029805e97dd3bf7f2b10e8007be03001 (patch)
treea80c12e97074f48f7cb8095de962a34fdcf207ae /README
parentb8a9f2c04e8f3e31d995c29551d97b102156b1ee (diff)
downloadsrtool-fba5cbb6029805e97dd3bf7f2b10e8007be03001.tar.gz
srtool-fba5cbb6029805e97dd3bf7f2b10e8007be03001.tar.bz2
srtool-fba5cbb6029805e97dd3bf7f2b10e8007be03001.zip
Add sample data, fix missing fixture files, update README
Signed-off-by: David Reyna <David.Reyna@windriver.com>
Diffstat (limited to 'README')
-rw-r--r--README24
1 files changed, 22 insertions, 2 deletions
diff --git a/README b/README
index 429b85ed..ed02fad8 100644
--- a/README
+++ b/README
@@ -1,9 +1,8 @@
SRTool
-=======
+------
SRTool is a set of GUI and command line tools to manage security CVEs.
-
For information about SRTool, see the website:
http://www.tbd.org/
@@ -11,6 +10,27 @@ SRTool plain documentation can be found under the doc directory or its integrate
html version at the Yocto Project website:
http://tbd.org/documentation
+Execution
+---------
+
+Here is how you run the SRTool.
+
+Clone this repository:
+ $ git push ssh://git@push.yoctoproject.org/srtool
+ $ cd srtool
+
+To start the SRtool (the first time will initialize the database):
+
+ Option 1: Start a local SRTool server, open local browser to "localhost:8000"
+ $ ./bin/srt start webport=8000
+
+ Option 2: Start a shared SRTool server, open any browser to "[host_ip]:8000"
+ $ ./bin/srt start webport=0.0.0.0:8000
+
+To stop the SRTool server:
+ $ ./bin/srt stop
+
+
Contributing
------------