Refactor README #22
Open
Refactor README #22
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
satriahrh
requested changes
Mar 27, 2018
| Not an Indonesian, just drop a request and I will work on it :D. | ||
| The research proposal then available by contacting me (DM, tweet, mention or anything) via Twitter: [@SatriaHRHarsono](https://twitter.com/SatriaHRHarsono). | ||
|
|
||
| ## System Block Diagram |
|
|
||
| Add additional notes about how to deploy this on a live system | ||
|
|
||
| ## Built With |
| 5. Install all requirements by `pip install -r requirements.txt` | ||
| 6. Do command `nosetests` and make sure all test case passed. | ||
|
|
||
| ## Running the tests |
There was a problem hiding this comment.
Replace sixth step of the installation to this section. Then ask the reader to check nosetests documentation
|
|
||
| Explain how to run the automated tests for this system | ||
|
|
||
| ### Break down into end to end tests |
There was a problem hiding this comment.
We are not going to put this on readme. Drop it
| Give an example | ||
| ``` | ||
|
|
||
| ### And coding style tests |
There was a problem hiding this comment.
We use automated checker: pylint to stylish our code.
| Give an example | ||
| ``` | ||
|
|
||
| ## Deployment |
|  | ||
| Project description |
There was a problem hiding this comment.
Implementation of Enhanced File to Image Encryption put this right below the title.
satriahrh
reviewed
Mar 27, 2018
| Steps to follow: | ||
| 1. Clone this repo from master branch https://github.com/hafizhme/ftie-rt-acm | ||
| 2. From the root project directory, Create a directory for virtual environment | ||
| 3. Create virtual environment by `virtualenv your-env` |
There was a problem hiding this comment.
Please add a consideration for virtualenv's naming. Some name will be ignored by git, see https://github.com/hafizhme/ftie-rt-acm/blob/master/.gitignore#L85
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.