install->glnxa64, added ADMIN, CHANGES and updated README

Author: silicon-vlsi

ADMIN.md

@@ -0,0 +1,75 @@
+# ADMIN
+This documentation is NOT for users, only if you are interested to compile, install and mange releases as done in this repo.
+
+## Compiling and Installing Netgen
+
+**SETTING UP LINUX FOR COMPILE**
+
+- Prepare for building netgen. 
+- Base dev pkgs if not already installed ```sudo apt install build-essential linux-headers-‘uname -r‘```
+- Some required packages if not already installed: **Tcl/Tk** (Ubuntu package names: ```tcl-dev, tk-dev```)
+ 
+**USING SOURCE FROM GIT REPO**
+
+- Compiled on Linux AWS Lightsail **5.4.0-1049-aws** #51~**18.04.1-Ubuntu**
+- cd ```/home/ubuntu/sit-git-repos/eda-src```
+- ```git clone git://opencircuitdesign.com/netgen```
+- ```cd netgen```
+- ```git checkout netgen-1.5```
+- Configure: To see all configure options ```./configure -----help```. To install in root with all default options just type ```./configure```
+- To install it in a user directory for eg. in ```$HOME/eda-bins/netgen```: 
+```bash 
+./configure --prefix=$HOME/eda-bins/netgen
+```
+- Make and install:
+```bash
+make
+make install
+```
+- On successful compilation, the new compiled binaries/libs/should be in the target directory eg. ```$HOME/eda-bins/netgen```
+  
+- **IMPORTANT** If this install directory needs to be used by other users by copying the install directory, replace the absolute paths: eg. ```/home/vlsi/tools/netgen-15 -> $NETGEN_HOME```
+- In the following files:
+```bash
+bin/netgen, lib/netgen/tcl/netgen.tcl
+```
+- Additionally, since the ```netgen.tcl``` is sourced from ```bin/netgen``` the environment variable needs to be passed by adding the following statement to ```netgen.tcl```:
+```tcl
+set NETGEN_HOME $::env(NETGEN_HOME)
+```
+- Set the environment variables as shown in [README.md](README.md)
+
+
+**CREATING A NEW RELEASE**
+
+Check out this [doc](https://docs.github.com/en/github/administering-a-repository/releasing-projects-on-github/managing-releases-in-a-repository) in docs.github.com on how to create and manage releases.
+  
+- Check out the difference between the previous and current version: eg.
+```bash
+  diff -qr ~/eda-bins/netgen  <GIT-INSTALL_DIR>/eda-netgen/glnxa64
+```
+- Copy only the differences to the git repo, `add`, `commit` and `push` to the `github`.
+  - **IMPORTANT** Make sure you backup the previous binaries in case you need it.
+- Navigate to the main repo page eg. github.com/silicon-vlsi-org/eda-netgen
+- To the right of the list of files, click **Create a new release** under the **Release** section.
+- Tag the release version eg. ```v1.5.0```
+  - The major release ```v1.5``` reflects the version of netgen.
+  - The minor release ```vx.x.0``` reflects any changes done locally eg. examples, docs, etc.
+- Do not add any binaries and do not select pre-release.
+- Publish the release. 
+- Now users can checkout this version eg. ```git checkout v8.3.0```
+  
+## Tasks
+- [ ] Add examples
+
+
+[OpenRAM]:              https://openram.soe.ucsc.edu/
+[OpenRAMgit]:           https://github.com/VLSIDA/OpenRAM 
+[OpenRAMpaper]:         https://ieeexplore.ieee.org/document/7827670/
+[SCMOS]:                https://www.mosis.com/files/scmos/scmos.pdf
+[NGSpice]:              http://ngspice.sourceforge.net
+[NGSpiceMan]:           http://ngspice.sourceforge.net/docs/ngspice-html-manual/manual.xhtml
+[Magic]:                http://opencircuitdesign.com/magic/
+[Netgen]:               http://opencircuitdesign.com/netgen/
+
+

CHANGES.md

@@ -0,0 +1,5 @@
+# CHANGES
+This file tracks all the changes to each of the releases.
+
+## v1.5.0
+- netgen 1.5 

README.md

@@ -1,58 +1,31 @@
 # Netgen
+### Current distribution version 1.5.0 
+Precompiled for **64b 18.04 Ubuntu and Ubuntu-based Linux**. It's also tested on a light-weight Ubuntu-variant LXLE distro. If you are interested in compiling from the source, instructions in [ADMIN.md:Compiling and Installing Magic](ADMIN.md) should help.
+
 [Netgen] is a tool for comparing netlists, a process known as LVS, which stands for "Layout vs. Schematic". This is an important step in the integrated circuit design flow, ensuring that the geometry that has been laid out matches the expected circuit.
 Netgen is currently maintained by Tim Edwards (opencircuitdesign.com/netgen)
 
-This repo contains pre-compiled binaries/libraries/etc of **Netgen Version 1.5** for **64-bit 18.04 Ubuntu Linux**. It's also tested on a light-weight Ubuntu-variant LXLE distro. If you are interested in compiling from the source, instructions in Section-[Compiling and Installing Netgen](#compiling-and-installing-netgen) should help.
+## Table of Content
+- [Downloading & Setting Up Netgen](#downloading-&-setting-up-netgen)
+- [Quick Start Guide](#quick-start-guide)
 
-## Setting up Netgen
+## Downloading & Setting Up Netgen
 
-- **NOTE**: The below is path is an example. Just make sure it matches your particular path.
-```bash
-export NETGEN_HOME=$HOME/eda-netgen
-export PATH=$PATH:$NETGEN_HOME/bin
-```
+- Change directory ```cd``` to install directory <INSTALL_DIR> e.g. ```/home/user/cad```
+- To download from the ```git``` repository:
+  - ```git clone https://github.com/silicon-vlsi-org/eda-netgen```
+- Change directory to the installed `netgen` directory eg. ```cd eda-netgen```
+- Checkout the desired version: ```git checkout v1.5.0```
+  - To make sure you are on the right version type ```git branch``` and your output should have a line like this :
+  - ```* (HEAD detached at v1.5.0)```
 
-## Compiling and Installing Netgen
+- Add the following environment variables in your `~/.bashrc` (**NOTE**: The path below is an example, make sure it matches your particular path) 
 
-- This repo is compiled on Linux AWS Lightsail **5.4.0-1049-aws #51~18.04.1-Ubuntu**
-- Clone and checkout the git repo:
-```bash
-git clone git://opencircuitdesign.com/netgen
-cd netgen
-git checkout netgen-1.5
-```
-- Some required packages if not already installed: **Tcl/Tk** (Ubuntu package names: ```tcl-dev, tk-dev```)
-- Configure: To see all configure options ```./configure -----help```. To install in root with all default options just type ```./configure```
-- To install it in a user directory: 
-```bash
-./configure --prefix=$HOME/eda-netgen
-```
-- Make and install:
 ```bash
-make
-make install
-```
-- **IMPORTANT** If this install directory needs to be used by other users by copying the install directory, replace the absolute paths: eg. ```/home/vlsi/tools/netgen-15 -> $NETGEN_HOME```
-- In the following files:
-```bash
-bin/netgen, lib/netgen/tcl/netgen.tcl
-```
-- Additionally, since the ```netgen.tcl``` is sourced from ```bin/netgen``` the environment variable needs to be passed by adding the following statement to ```netgen.tcl```:
-```tcl
-set NETGEN_HOME $::env(NETGEN_HOME)
+export NETGEN_HOME=$HOME/eda-netgen
+export PATH=$PATH:$NETGEN_HOME/bin
 ```
 
-## Tasks
-- [ ] Add examples
-
-
-[OpenRAM]:              https://openram.soe.ucsc.edu/
-[OpenRAMgit]:           https://github.com/VLSIDA/OpenRAM 
-[OpenRAMpaper]:         https://ieeexplore.ieee.org/document/7827670/
-[SCMOS]:                https://www.mosis.com/files/scmos/scmos.pdf
-[NGSpice]:              http://ngspice.sourceforge.net
-[NGSpiceMan]:           http://ngspice.sourceforge.net/docs/ngspice-html-manual/manual.xhtml
-[Magic]:                http://opencircuitdesign.com/magic/
-[Netgen]:               http://opencircuitdesign.com/netgen/
-
+## Quick Start Guide
+FIXME: Add examples to the repo