summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorgregory guy <[email protected]>2019-12-31 14:28:05 +0100
committerMichele Calgaro <[email protected]>2020-01-02 00:25:49 +0900
commit39822b9bec4467b33955916ce10ecc64e5081edd (patch)
tree53b2b99cac17c8ab06afe3c689ce7e356fd93484 /doc
parenta73f6db940adbd60d1df65b5060bbcf67c867361 (diff)
downloadkpicosim-39822b9bec4467b33955916ce10ecc64e5081edd.tar.gz
kpicosim-39822b9bec4467b33955916ce10ecc64e5081edd.zip
Drop automake build support.
Add basic build instructions to the INSTALL file. Remove empty file NEWS. Rework of the README and help page. Signed-off-by: gregory guy <[email protected]> (cherry picked from commit 55922fcee851967d9f06fa359b085bcbc00dfc75)
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile.am6
-rw-r--r--doc/en/Makefile.am2
-rw-r--r--doc/en/index.docbook27
3 files changed, 13 insertions, 22 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
deleted file mode 100644
index 070deaa..0000000
--- a/doc/Makefile.am
+++ /dev/null
@@ -1,6 +0,0 @@
-# the SUBDIRS is filled automatically by am_edit. If files are
-# in this directory they are installed into the english dir
-
-KDE_LANG = en
-KDE_DOCS = kpicosim
-SUBDIRS = $(AUTODIRS)
diff --git a/doc/en/Makefile.am b/doc/en/Makefile.am
deleted file mode 100644
index be0ab90..0000000
--- a/doc/en/Makefile.am
+++ /dev/null
@@ -1,2 +0,0 @@
-KDE_DOCS = kpicosim
-KDE_LANG = en
diff --git a/doc/en/index.docbook b/doc/en/index.docbook
index 7231ae1..1aefc02 100644
--- a/doc/en/index.docbook
+++ b/doc/en/index.docbook
@@ -118,7 +118,7 @@ problems. Basically a long version of the abstract. Don't include a
revision history. (see installation appendix comment) -->
<para>
-&kpicosim; is a development environment for the Xilinx PicoBlaze-3 soft-core processor for the KDE Desktop (Linux). The environment has an editor with syntax highlighting, compiler, simulator and export functions to VHDL, HEX and MEM files.
+&kpicosim; is a development environment for the Xilinx PicoBlaze-3 soft-core processor for the TDE Desktop (Linux). The environment has an editor with syntax highlighting, compiler, simulator and export functions to VHDL, HEX and MEM files.
</para>
</chapter>
@@ -308,7 +308,7 @@ part of KDE CVS. You should remove it if you are releasing your
application -->
<para>
-&kpicosim; can be found at <ulink url="http://www.xs4all.nl/~marksix">http://www.xs4all.nl/~marksix</ulink>. This is the project homepage.
+The source code is available at <ulink url="https://mirror.git.trinitydesktop.org/gitea/TDE/kpicosim">https://mirror.git.trinitydesktop.org/gitea/TDE/kpicosim</ulink> .
</para>
</sect1>
@@ -328,7 +328,7 @@ information here.
-->
<para>
-..Write me...
+&kpicosim; relies on the TDE libraries (tdelibs) to build.
</para>
<para>
@@ -337,10 +337,6 @@ information here.
<!-- For a list of updates, you may refer to the application web site
or the ChangeLog file, or ... -->
-<para>
-You can find a list of changes at <ulink
-url="http://www.xs4all.nl/~marksix">http://www.xs4all.nl/~marksix</ulink>.
-</para>
</sect1>
<sect1 id="compilation">
@@ -350,15 +346,19 @@ url="http://www.xs4all.nl/~marksix">http://www.xs4all.nl/~marksix</ulink>.
<!-- compilation instructions. If your application requires any -->
<!-- special handling, remove it, and replace with your own text. -->
-&install.compile.documentation;
+<para>
+In order to compile and install &kpicosim; on your system, you will need cmake.
-</sect1>
+<screen width="40">
+<prompt>%</prompt> <userinput>mkdir -p build</userinput>
+<prompt>%</prompt> <userinput>cd build</userinput>
+<prompt>%</prompt> <userinput>cmake ..</userinput>
+<prompt>%</prompt> <userinput>make install</userinput>
+</screen>
-<sect1 id="configuration">
-<title>Configuration</title>
-<para>
-..Write me..
+For further instructions, please, read the INSTALL file.
</para>
+
</sect1>
</appendix>
@@ -377,4 +377,3 @@ End:
vim:tabstop=2:shiftwidth=2:expandtab
-->
-