docs: Generate README.rst to work around GitHub not rendering `.. include::` in rst files.
This work might look like extensive for just fixing a small issue like
the include rendering, but it will all be heavily reused by the
skywater-pdk scripts that will be released soon.
This commit;
- Adds Makefile for creating a self contained conda environment under
`env/conda`
- Installs required Python dependencies into the environment (which is
currently just the `rst_include` tool).
- Has a Makefile 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: Tim 'mithro' Ansell <tansell@google.com>
diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..0bb8b96
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,22 @@
+# Copyright 2020 SkyWater PDK Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+
+include scripts/make/git.mk
+include scripts/make/conda.mk
+
+README.rst: README.src.rst docs/status.rst | $(CONDA_ENV_PYTHON)
+ @rm -f README.rst
+ $(IN_CONDA_ENV) rst_include include --source README.src.rst | sed -e's/|TAG_VERSION|/$(TAG_VERSION)/g' > README.rst
