luke
/
prjxray-db
mirror of https://github.com/openXC7/prjxray-db.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Adding useful user documentation. 

Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
This commit is contained in:
Tim 'mithro' Ansell 2017-12-20 22:13:03 +01:00
parent c06740c1a4
commit b550e48a3e
3 changed files with 54 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
CONTRIBUTING.md Normal file
View File

@ -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.

13
COPYING Normal file
View File

@ -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.

36
README.md Normal file
View File

@ -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 <me@mith.ro>. 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).