Skip to content

Commit ee464a7

Browse files
committed
updated README.md
1 parent ba20a1a commit ee464a7

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,16 @@ Markdown is an awesome way to format text in a texteditor and can be interpreted
55
Another cool thing about this project is that there are 76 unittests which hopefully did catch all edgecases for my codebase.
66

77
## How to use this codebase
8-
1. '''gitclone https://github.com/LS-2ednar/PutToWeb'''
8+
1. `gitclone https://github.com/LS-2ednar/PutToWeb`
99
2. Write your content and store it in your content directory
10-
3. Using '''./main.sh''' you can create a locally hosted version of your static site when checking out '''https://localhost:8888/'''
11-
4. When you are ready to push your website to the web, '''./build.sh'''
12-
5. On Github in your repo go to '''Settings''' -> '''Pages''' -> at the source select '''main''' and '''docs''' as this is where src/main.py will save the html for your webpage.
10+
3. Using `./main.sh` you can create a locally hosted version of your static site when checking out `https://localhost:8888/`
11+
4. When you are ready to push your website to the web, `./build.sh`
12+
5. On Github in your repo go to `Settings` -> `Pages` -> at the source select `main` and `docs` as this is where src/main.py will save the html for your webpage.
1313

1414
## Used libraries
1515
- os
1616
- sys
17-
- Unittest for Unittests
17+
- Unittest for Unittests
18+
19+
## Future improvements
20+
- Add documentation on how to host pages on another domain

0 commit comments

Comments
 (0)