Public version of README.md

README.md

@@ -1,81 +1,10 @@
-# PYNQ
-(PY)thon on Zy(NQ)
-
-
-## SDCard Image Files
-
-- All Pynq-Z1 images including the latest are available here: 
-```
-file://xsj-pvstd2t01-w/xrlabs/grahams/public/pynq-z1_images/
-``` 
-
-- After imaging, change the board's hostname to avoid network conflicts
-```
-sudo /home/xilinx/scripts/hostname.sh A_UNIQUE_HOSTNAME
-```
-
-
-## Updating `pynq` using `update_pynq.sh`
-
-This is a recommended way to update the `pynq` package. The script usage can be checked using:
-```
-sudo ./update_pynq.sh -h
-```
-By default, The script will do the following:
-
-- Update or clone Git repository in `/home/xilinx`.
-- Checkout the latest stable release in Repo.
-- Install the `pynq` python package.
-- Copy board-specific files into the `pynq` package.
-- Copy the Jupyter notebooks into `/home/xilinx/jupyter_notebooks`.
-- Copy documentation into `/home/xilinx/docs`.
-- Update other useful scripts in `/home/xilinx/scripts` and itself before exiting.
-
-To run this script, first verify the `$BOARD` environment variable has been set correctly:
-```
-echo $BOARD
-```
-
-* If `$BOARD` is not set, add `export BOARD=Pynq-Z1` to `/etc/environment`.
-Then either reboot the board, or run the following:
-
-	```
-	source /etc/environment
-	```
-
-* If `$BOARD` has already been set, just run:
-	```
-	cd /home/xilinx/scripts
-
-	# To get latest stable git updates
-	sudo ./update_pynq.sh
-
-	# To get latest git updates (dev option)
-	sudo ./update_pynq.sh -l
-
-	# To Build Documentation from sources (dev option)
-	sudo ./update_pynq.sh -d
-	```
-
-## Updating `pynq` using `pip` 
-
-It is not recommended to update `pynq` using `pip`, since there are still many board-specific files to be copied from the repository.
-
-The developer mode will pull entire github repository, but again, the board-specific files are not copied to `pynq`.
-
-```
-# (deprecated)
-sudo -H pip install --upgrade 'git+https://github.com/Xilinx/PYNQ@master#egg=pynq&subdirectory=python'
-
-# (deprecated) Developer mode
-sudo -H pip install -e 'git+https://github.com/Xilinx/PYNQ@master#egg=pynq&subdirectory=python'
-```
-
-## Running Regression from Terminal
-
-The pytests have to be run under root privilege:
-
-```
-cd /usr/local/lib/python3.4/dist-packages/pynq
-sudo py.test -vsrw
-```
+![alt tag](https://github.com/Xilinx/PYNQ/blob/master/pynq_logo_200.png)
+
+PYNQ is an open-source project from Xilinx that makes it easy to design embedded systems with Zynq All Programmable Systems on Chips (APSoCs). Using the Python language and libraries, designers can exploit the benefits of programmable logic and microprocessors in Zynq to build more capable and exciting embedded systems.
+PYNQ users can now create high performance embedded applications with
+-	parallel hardware execution
+-	high frame-rate video processing
+-	hardware accelerated algorithms
+-	real-time signal processing
+-	high bandwidth IO
+-	low latency control