summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorxengineering <mail2xengineering@protonmail.com>2020-09-03 14:12:46 +0200
committerxengineering <mail2xengineering@protonmail.com>2020-09-03 14:12:46 +0200
commitc21fda4b08b4899ebf4b9eb13d0bb1e0aab15cbe (patch)
treef3cc869d4d81756157ede28328fecc50ee5c240f /README.md
parent9a1ff86ab7eeb0cf5f21ebe927737a99675e7594 (diff)
downloadweb-template-c21fda4b08b4899ebf4b9eb13d0bb1e0aab15cbe.tar
web-template-c21fda4b08b4899ebf4b9eb13d0bb1e0aab15cbe.tar.zst
web-template-c21fda4b08b4899ebf4b9eb13d0bb1e0aab15cbe.zip
Add Instructions to use it with custom Projects
Diffstat (limited to 'README.md')
-rw-r--r--README.md37
1 files changed, 28 insertions, 9 deletions
diff --git a/README.md b/README.md
index 0790f9a..57f8039 100644
--- a/README.md
+++ b/README.md
@@ -7,19 +7,38 @@ A template project for dynamic web applications.
## Usage
+### Just try it
```
- # Install Flask and waitress with your linux package manager.
- # Otherwise you could use pip:
- pip3 install --user Flask waitress
+# Install Flask and waitress with your linux package manager.
+# Otherwise you could use pip:
+pip3 install --user Flask waitress
- git clone https://github.com/xengineering/web-template.git
- cd web-template
- python3 main.py
+git clone https://github.com/xengineering/web-template.git
+cd web-template
+python3 main.py
- # switch to another terminal
+# switch to another terminal
- curl http://localhost:8080 # test with curl
- firefox http://localhost:8080 # test with firefox
+curl http://localhost:8080 # test with curl
+firefox http://localhost:8080 # test with firefox
+```
+
+### Use it for your Project
+```
+# start 'myproject' (rename it if you want to)
+git clone https://github.com/xengineering/web-template.git myproject
+cd myproject
+git remote rename origin template
+git branch template # create branch for the template
+git branch --set-upstream-to=template/master template
+git branch --unset-upstream master
+```
+
+### Add a Remote for your specific Project
+```
+git remote add origin <myproject-upstream-url>
+git branch -M master
+git push -u origin master
```