Add quickstart guide

[anoadragon453]

Just need to finish it up.

[0x766C70]

hi @anoadragon453 !

First, thanks for your job !

I juste tried to run it out of the box with a basic config: homeserver + user + passwd and there is an error:

Traceback (most recent call last): File "main.py", line 104, in <module> asyncio.get_event_loop().run_until_complete(main()) File "/usr/lib/python3.7/asyncio/base_events.py", line 584, in run_until_complete return future.result() File "main.py", line 34, in main config = Config(config_filepath) File "/home/vlp/nio-template/config.py", line 45, in __init__ self.database_filepath = self._get_cfg(["storage", "database_filepath"], required=True) File "/home/vlp/nio-template/config.py", line 89, in _get_cfg raise ConfigError(f"Config option {'.'.join(path)} is required") errors.ConfigError: Config option storage.database_filepath is required

I just modified the config file for the db as below:

storage:

database_filepath: "bot.db"

store_filepath: "/home/vlp/nio-template/store

I have posted it here because that could help to build the quickstart guide.

Thanks again !

[anoadragon453]

Hey @vlp-git, as shown in sample_config.yaml, you'll need to put database_filepath (and store_filepath) under a storage key. Else the code won't be able to find them :)

[0x766C70]

Thanks for the quick answer !
What do you mean by "storage key" ! I think that I have missed smth...

[anoadragon453]

The options need to be prefaced by storage:

nio-template/sample.config.yaml

Lines 22 to 27 in a49c789

	storage:
	# The path to the database
	database_filepath: "bot.db"
	# The path to a directory for internal bot storage
	# containing encryption keys, sync tokens, etc.
	store_filepath: "./store"