mirror of
https://git.ianrenton.com/ian/spothole.git
synced 2025-10-27 16:59:25 +00:00
README and main filename change
This commit is contained in:
2
.idea/runConfigurations/Run.xml
generated
2
.idea/runConfigurations/Run.xml
generated
@@ -12,7 +12,7 @@
|
|||||||
<option name="IS_MODULE_SDK" value="true" />
|
<option name="IS_MODULE_SDK" value="true" />
|
||||||
<option name="ADD_CONTENT_ROOTS" value="true" />
|
<option name="ADD_CONTENT_ROOTS" value="true" />
|
||||||
<option name="ADD_SOURCE_ROOTS" value="true" />
|
<option name="ADD_SOURCE_ROOTS" value="true" />
|
||||||
<option name="SCRIPT_NAME" value="$PROJECT_DIR$/main.py" />
|
<option name="SCRIPT_NAME" value="$PROJECT_DIR$/spothole.py" />
|
||||||
<option name="PARAMETERS" value="" />
|
<option name="PARAMETERS" value="" />
|
||||||
<option name="SHOW_COMMAND_LINE" value="false" />
|
<option name="SHOW_COMMAND_LINE" value="false" />
|
||||||
<option name="EMULATE_TERMINAL" value="false" />
|
<option name="EMULATE_TERMINAL" value="false" />
|
||||||
|
|||||||
23
README.md
23
README.md
@@ -20,10 +20,31 @@ TODO
|
|||||||
|
|
||||||
### Running your own copy
|
### Running your own copy
|
||||||
|
|
||||||
TODO
|
To download and set up Spothole on a Debian server, run the following commands. Other operating systems will likely be similar.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone ssh://git@git.ianrenton.com/ian/spothole.git
|
||||||
|
cd spothole
|
||||||
|
python3 -m venv ./.venv
|
||||||
|
source .venv/bin/activate
|
||||||
|
pip install -r requirements.txt
|
||||||
|
deactivate
|
||||||
|
cp config-example.yml config.yml
|
||||||
|
```
|
||||||
|
|
||||||
|
Then edit `config.yml` in your text editor of choice to set up the software as you like it.
|
||||||
|
|
||||||
|
Then, to run the software this time and any future times you want to run it directly from the command line:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
source .venv/bin/activate
|
||||||
|
python3 spothole.py
|
||||||
|
```
|
||||||
|
|
||||||
The software can take a few seconds to start up, mostly because it is downloading an updated file to match callsigns to countries. This is normal, don't panic!
|
The software can take a few seconds to start up, mostly because it is downloading an updated file to match callsigns to countries. This is normal, don't panic!
|
||||||
|
|
||||||
|
If you see some errors on startup, check your configuration, e.g. in case you have specified a port for the web server that is already in use by something else.
|
||||||
|
|
||||||
### Writing your own client
|
### Writing your own client
|
||||||
|
|
||||||
TODO
|
TODO
|
||||||
|
|||||||
Reference in New Issue
Block a user