Restructure readme #162
Restructure readme #162
Conversation
removed file and command for PyQtGraph patch
added filter for decompressing compressed strace data
…arly-database-update
Suppress lief stdout
Early database update
Sd16 analysis blacklist system
code preview hightlighting added
Intel hex unpacker
…to restructure_readme
Codecov Report
@@ Coverage Diff @@
## master #162 +/- ##
==========================================
- Coverage 95.79% 95.79% -0.01%
==========================================
Files 309 309
Lines 15326 15326
==========================================
- Hits 14682 14681 -1
- Misses 644 645 +1
Continue to review full report at Codecov.
|
INSTALL.md
Outdated
|
|
||
| ## TL;DR | ||
|
|
||
| 0. `(cd path/to/fact/sources && ./pre_install.sh)` |
There was a problem hiding this comment.
path should be "src/bootstrap/pre_install.sh"
| The main.cfg on the frontend system has to be altered so that the values of `data_storage.mongo_server` and `data_storage.mongo_port` match the **ip:port** for the database. | ||
| The same has to be done for the backend. In addition, since the raw firmware and file binaries are stored in the backend, the `data_storage.firmware_file_storage_directory` has to be created (by default `/media/data/fact_fw_data`). | ||
| On the database system, the `mongod.conf` has to be given the correct `net.bindIp` and `net.port`. In addition the path in `storage.dbPath` of the `mongod.conf` has to be created. | ||
|
|
There was a problem hiding this comment.
The install options should be explained as well ./install.py [-B -D -F]
Furhtermore we should mention that the databse should be started first.
There was a problem hiding this comment.
I disagree with the second request. Starting the database first - or at all - has nothing to do with installation but execution. This should be documented in a getting started page.
Removed installation details from readme and added a more extensive markdown for installation.
Fixed some deprecated information and added a nicer representation for requirements.