summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSlávek Banko <slavek.banko@axis.cz>2018-08-12 16:50:48 +0200
committerSlávek Banko <slavek.banko@axis.cz>2018-08-12 16:54:11 +0200
commit62a4b15210d17069a7a46e6dfbd5d8f471967657 (patch)
tree1a42f901edd4fa0943dcc39fee03f065d9f5c4fa
parent06d851e65bc4ccad32f0316474b7c03d40f08189 (diff)
downloadtde-62a4b15210d17069a7a46e6dfbd5d8f471967657.zip
tde-62a4b15210d17069a7a46e6dfbd5d8f471967657.tar.gz
Add simple readme with instructions for cloning the entire repository tree
Signed-off-by: Slávek Banko <slavek.banko@axis.cz>
l---------README.GIT1
-rw-r--r--Readme.md28
2 files changed, 28 insertions, 1 deletions
diff --git a/README.GIT b/README.GIT
deleted file mode 120000
index bfaee0d..0000000
--- a/README.GIT
+++ /dev/null
@@ -1 +0,0 @@
-scripts/README.GIT \ No newline at end of file
diff --git a/Readme.md b/Readme.md
new file mode 100644
index 0000000..fbad154
--- /dev/null
+++ b/Readme.md
@@ -0,0 +1,28 @@
+# Trinity Desktop Environment GIT Repositories
+
+TDE is a comprehensive desktop environment that includes both
+core packages and applications designed for it.
+
+The complete source code is split into many individual GIT repositories,
+connected together into a tree structure of modules and submodules. The
+main *TDE* repository provides the entry point to the root of such tree,
+simplifying navigation and cloning operation of the complete TDE code.
+
+TDE packaging repository contains files designed to create source and
+binary packages for distributions such as Debian, Fedora, and so on.
+
+
+## Check out the complete TDE source code
+
+To check out the complete source tree from GIT,
+you can use the following procedure:
+
+```
+git clone https://mirror.git.trinitydesktop.org/gitea/TDE/tde
+git clone https://mirror.git.trinitydesktop.org/gitea/TDE/tde-packaging
+cd tde
+git submodule init -- scripts
+git submodule update -- scripts
+./scripts/switch_all_submodules_to_head_and_clean anonymous
+
+```