From b550e48a3ef2a635f8ed54693272fbdf5883e684 Mon Sep 17 00:00:00 2001 From: Tim 'mithro' Ansell Date: Wed, 20 Dec 2017 22:13:03 +0100 Subject: [PATCH] Adding useful user documentation. Signed-off-by: Tim 'mithro' Ansell --- CONTRIBUTING.md | 5 +++++ COPYING | 13 +++++++++++++ README.md | 36 ++++++++++++++++++++++++++++++++++++ 3 files changed, 54 insertions(+) create mode 100644 CONTRIBUTING.md create mode 100644 COPYING create mode 100644 README.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b622d84 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,5 @@ +This repository doesn't accept external contributions, you probably want to +[contribute to Project X-Ray](https://github.com/SymbiFlow/prjxray/blob/master/CONTRIBUTING.md) +and then request +[Tim 'mithro' Ansell](mailto:me@mith.ro) update the database. + diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..665f8c2 --- /dev/null +++ b/COPYING @@ -0,0 +1,13 @@ +Copyright (C) 2017 The Project X-Ray Authors. All rights reserved. + +Permission to use, copy, modify, and/or distribute this software for any +purpose with or without fee is hereby granted, provided that the above +copyright notice and this permission notice appear in all copies. + +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..2445a74 --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ +# Project X-Ray - Xilinx Series 7 Bitstream Documentation + +This repo contains the bitstream documentation database for Xilinx Series 7 +devices. + +[HTML version of the Xilinx Series 7 BitStream is avaliable on https://symbiflow.github.io/prjxray-db](https://symbiflow.github.io/prjxray-db). + +This documentation was generated using the +[Project X-Ray tools](https://github.com/SymbiFlow/prjxray). + +Due to the long time taken to create this database yourself, a prebuilt version +is currently being provided by Tim 'mithro' Ansell . The database +is intended to kept in sync with the current prjxray output, but due to the +manual nature required to create it, it may sometimes lag behind +what you could create yourself using those tools. + +Please try contacting [mailto:me@mith.ro](Tim) if you believe the database is +more than a week out of date. + +# Contributions + +As this repo is created from the prjxray output it doesn't accept external +contributions. You are encourage to generate and maintain your own versions of +this documentation if your needs are not being met by this repository. + +The +[htmlgen.py](https://github.com/SymbiFlow/prjxray/blob/master/htmlgen/htmlgen.py) +is kept in sync with the version in +[Project X-Ray](https://github.com/SymbiFlow/prjxray), please contribute all changes to +that file and then request Tim to rebuild the HTML output. + +# License + +These files are released under the very permissive +[ISC License, see the COPYING file for the full text](COPYING). +