From 564b815ae4d71de78b460db1c53fb26830ee1bd6 Mon Sep 17 00:00:00 2001 From: Mantas Vilčinskas Date: Sat, 1 May 2021 23:26:00 +0300 Subject: v5.0.2 example site repo instructions --- exampleSite/README.md | 32 ++++++++++++++++++++++++++++++++ exampleSite/README.txt | 3 --- 2 files changed, 32 insertions(+), 3 deletions(-) create mode 100644 exampleSite/README.md delete mode 100644 exampleSite/README.txt (limited to 'exampleSite') diff --git a/exampleSite/README.md b/exampleSite/README.md new file mode 100644 index 0000000..c9d32e0 --- /dev/null +++ b/exampleSite/README.md @@ -0,0 +1,32 @@ +# cState Example Site v5.0.2 + +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 yoru site with all the directories. `git clone --recursive ` + +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 `. Your status page is now updated and uploaded. + + +## For maintainers (probably not for you) + +Download this repo with all the directories. `git clone --recursive -b master https://github.com/cstate/example.git` + +Make your changes. + +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 diff --git a/exampleSite/README.txt b/exampleSite/README.txt deleted file mode 100644 index 4664609..0000000 --- a/exampleSite/README.txt +++ /dev/null @@ -1,3 +0,0 @@ -This is the default cState status page website directory/folder. - -https://github.com/cstate/example -- cgit v1.2.3-70-g09d2