Initial commit

Author: almahmoud

.gitlab-ci.yml

@@ -0,0 +1,28 @@
+# SERVING CSTATE ON GITLAB PAGES
+# Introduced in v4.2.1
+#
+# This file is very similar to the existing GitLab template, and might need editing before it works on your project.
+#
+# All available Hugo versions are listed here:
+# https://gitlab.com/pages/hugo/container_registry
+#
+# cState uses Hugo Extended.
+image: registry.gitlab.com/pages/hugo/hugo_extended:0.100.2
+
+variables:
+  GIT_SUBMODULE_STRATEGY: recursive
+
+test:
+  script:
+    - hugo
+  except:
+    - master
+
+pages:
+  script:
+    - hugo
+  artifacts:
+    paths:
+      - public
+  only:
+    - master

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "themes/cstate"]
+	path = themes/cstate
+	url = https://github.com/cstate/cstate

README.md

@@ -0,0 +1,33 @@
+# cState Site v5.5
+
+This is the default cState status page website directory/folder.
+
+* Example site repository link (you are here): https://github.com/cstate/example
+* Main cState source code repository: https://github.com/cstate/cstate
+
+## Are you updating? Use these commands
+
+Download your site with all the directories. `git clone --recursive <your repo link goes here>`
+
+Update the cState theme submodule. `git submodule foreach git pull origin master`
+
+In the parent directory, type `hugo serve`. Check to see if everything is working.
+
+Then do `git add -A; git commit -m "Update cState"; git push origin <branch, probably main or master>`. Your status page is now updated and uploaded.
+
+
+## For maintainers (probably not for you)
+
+Maintainers need to update both cstate/cstate and cstate/example for each new version.
+
+Download this repo with all the directories. `git clone --recursive -b master https://github.com/cstate/example.git`
+
+Add your changes from cstate/cstate's exampleSite folder.
+
+Update the cState theme submodule. `git submodule foreach git pull origin master`
+
+Then push `git add -A; git commit -m "Update cState vX.X.X"; git push origin master`.
+
+## License
+
+MIT © Mantas Vilčinskas