Remove examples directory and improvement documentation #47
Conversation
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
Signed-off-by: Kamil Rakoczy <krakoczy@antmicro.com>
Can you log a github issue about this? |
See the solution we use in skywater-pdk -> https://github.com/google/skywater-pdk
|
eos-s3/README.md
Outdated
| source "$INSTALL_DIR/conda/etc/profile.d/conda.sh" | ||
| conda env create -f eos-s3/environment.yml | ||
| conda activate eos-s3 | ||
| wget -qO- https://quicklogic-my.sharepoint.com/:u:/p/kkumar/Eb7341Bq-XRAukVQ6oQ6PrgB-qdFbrsrPEON1yTa4krFSA?download=1 | tar -xJ -C $INSTALL_DIR |
There was a problem hiding this comment.
These two steps highlight that the quicklogic install instructions are wrong. They should;
- not be referencing sharepoint / kkumar,
- not doing a copy.
There was a problem hiding this comment.
This commands where copied directly from hidden installation script of quicklogic toolchain installator.
To not reference sharepoint / kkumar quicklogic archdef needs to be uploaded somewhere else. Probably this should be done by someone from QL.
Copy is fixing the problem with yosys not finding shared files. It is probably a bug in the quicklogic-yosys conda package. The same copy is done in the hidden installation script.
If we do not want to directly copy we need a fixed conda package or still use the official installation script.
There was a problem hiding this comment.
This commands where copied directly from hidden installation script of quicklogic toolchain installator.
To not reference sharepoint / kkumar quicklogic archdef needs to be uploaded somewhere else. Probably this should be done by someone from QL.
This should be generated from CI automatically. Talk to @kgugala about who should own fixing this.
Copy is fixing the problem with yosys not finding shared files. It is probably a bug in the quicklogic-yosys conda package. The same copy is done in the hidden installation script.
If we do not want to directly copy we need a fixed conda package or still use the official installation script.
Please log bugs about these issues. Both the conda package and the official installation script probably need fixing.
I created new issue: #48 |
This commit is workaround for Github not rendering `.. include::`. This PR adds: - Adds Makefile for creating conda environment under `env/conda` and installs `rst_include` tool. - Adds make README.rst target to generate `README.rst` from `README.src.rst` - Has Travis CI run on repository and check that the `README.rst` file has been rebuilt and committed if any of the dependencies have change. Signed-off-by: Kamil Rakoczy <krakoczy@antmicro.com>
|
I'm going to merge this. There are a bunch of follow up items which need to be logged as issues and then cleaned up. |
Fixes #25
Supersede of #39
CI will fail, as tests are downloading master version, not version from this PR.
This pull request: