tobast/matrix-alertbot
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Remove references to GETTING_STARTED.md for now

Browse source
This commit is contained in:
Andrew Morgan 2020-10-05 15:32:49 +01:00
parent 62111f0ca6
commit 8c7a5dbd2e
1 changed files with 2 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
SETUP.md
View file

@ -2,9 +2,7 @@
nio-template is a sample repository of a working Matrix bot that can be taken nio-template is a sample repository of a working Matrix bot that can be taken
and transformed into one's own bot, service or whatever else may be necessary. and transformed into one's own bot, service or whatever else may be necessary.
Below is a quick setup guide to running the existing bot. For guidance on how Below is a quick setup guide to running the existing bot.
to get started on transforming the codebase into your own, personalised
chatbot, see [GETTING_STARTED.md](GETTING_STARTED.md).
## Install the dependencies ## Install the dependencies
@ -140,8 +138,7 @@ my-project-name
You'll notice that "my-project-name" is scattered throughout the codebase. When You'll notice that "my-project-name" is scattered throughout the codebase. When
it comes time to modifying the code for your own purposes, you are expected to it comes time to modifying the code for your own purposes, you are expected to
replace every instance of "my-project-name" and its variances with your own replace every instance of "my-project-name" and its variances with your own
project's name. Details on doing so are described in project's name.
[GETTING_STARTED.md](GETTING_STARTED.md).
By default, the bot will run with the config file at `./config.yaml`. However, an By default, the bot will run with the config file at `./config.yaml`. However, an
alternative relative or absolute filepath can be specified after the command: alternative relative or absolute filepath can be specified after the command: