From cc96c4ff1a83c36055ad731563d8cef701a0c6ed Mon Sep 17 00:00:00 2001 From: Joyanta Date: Sat, 15 Jan 2022 00:56:51 +0600 Subject: [PATCH] Updated the installation process for newbies of Github --- README.md | 30 +++++++++++++++++++----------- 1 file changed, 19 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index bcd90af..6c23785 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,15 @@ Following are some network representations:
Holistically-Nested Edge Detection (view on Overleaf)
## Getting Started -1. Install the following packages on Ubuntu. + +1. Clone the repo to your PC. To clone, type in your terminal + + ``` + git clone https://github.com/HarisIqbal88/PlotNeuralNet.git + ``` + +### Ubuntu +2. Install the following packages on Ubuntu. * Ubuntu 16.04 ``` sudo apt-get install texlive-latex-extra @@ -34,11 +42,12 @@ Base on this [website](https://gist.github.com/rain1024/98dd5e2c6c8c28f9ea9d), p sudo apt-get install texlive-latex-extra ``` - * Windows - 1. Download and install [MikTeX](https://miktex.org/download). - 2. Download and install bash runner on Windows, recommends [Git bash](https://git-scm.com/download/win) or Cygwin(https://www.cygwin.com/) +### Windows + +2. Download and install [MikTeX](https://miktex.org/download). +2.1. Download and install bash runner on Windows. [Git Bash](https://git-scm.com/download/win) is recommended. Or you can use [Cygwin](https://www.cygwin.com/) -2. Execute the example as followed. +3. Execute the example as followed. ``` cd pyexamples/ bash ../tikzmake.sh test_simple @@ -57,13 +66,15 @@ See [`examples`](examples) directory for usage. ## Python usage -First, create a new directory and a new Python file: +### Usage Case 1: + +1. First, create a new directory from the default folder of the project and a new Python file: $ mkdir my_project $ cd my_project vim my_arch.py -Add the following code to your new file: +2. Add the following code to your new file: ```python import sys @@ -93,9 +104,6 @@ if __name__ == '__main__': main() ``` -Now, run the program as follows: +3. Now, run the program as follows: bash ../tikzmake.sh my_arch - - -