aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md45
1 files changed, 23 insertions, 22 deletions
diff --git a/README.md b/README.md
index d6cf9cd..9073e7f 100644
--- a/README.md
+++ b/README.md
@@ -4,28 +4,29 @@ BCST allow you to create a beautiful start page very quickly. To install the dep
> pip install jinja2
-Simple right a simple json resource file:
-
- {
- "title": "Default Theme",
- "bookmarks": {
- "engines": {
- "Qwant": "https://www.qwant.com/",
- "DDG": "https://duckduckgo.com/",
- "Google": "http://google.fr"
- },
- "Reddit": {
- "Home": "https://www.reddit.com/",
- "Unixporn": "https://www.reddit.com/r/Unixporn",
- "Linux": "https://www.reddit.com/me/m/linux"
- },
- "Social": {
- "Discord": "https://discordapp.com/channels/@me",
- "Twitter": "https://twitter.com/",
- "LinuxRocks": "https://linuxrocks.online/web/getting-started"
- }
- }
- }
+Simple write a simple json resource file:
+```
+{
+ "title":"Default Theme",
+ "bookmarks":{
+ "engines":{
+ "Qwant":"https://www.qwant.com/",
+ "DDG":"https://duckduckgo.com/",
+ "Google":"http://google.fr"
+ },
+ "Reddit":{
+ "Home":"https://www.reddit.com/",
+ "Unixporn":"https://www.reddit.com/r/Unixporn",
+ "Linux":"https://www.reddit.com/me/m/linux"
+ },
+ "Social":{
+ "Discord":"https://discordapp.com/channels/@me",
+ "Twitter":"https://twitter.com/",
+ "LinuxRocks":"https://linuxrocks.online/web/getting-started"
+ }
+ }
+}
+```
Then simply run:
> ./src/bcst.py \<resource-file-path> \<start-page-destination>