Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated the installation process for beginner users of Github #125

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Updated the installation process for beginner users of Github #125

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 19 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,15 @@ Following are some network representations:
<h6 align="center">Holistically-Nested Edge Detection (<a href="https://www.overleaf.com/read/jxhnkcnwhfxp">view on Overleaf</a>)</h6>

## 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
Expand All @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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