From 0ed055a0a4237112dbff73aceefd4ca4d2539900 Mon Sep 17 00:00:00 2001 From: Griatch Date: Sun, 23 Oct 2022 11:26:47 +0200 Subject: [PATCH] Add info in install docs on switching to develop branch for now. Resolve #2689 --- docs/source/Setup/Installation-Git.md | 26 ++++++++++++++++---------- docs/source/Setup/Settings-Default.md | 3 ++- 2 files changed, 18 insertions(+), 11 deletions(-) diff --git a/docs/source/Setup/Installation-Git.md b/docs/source/Setup/Installation-Git.md index c16d98266f..1ffffa220a 100644 --- a/docs/source/Setup/Installation-Git.md +++ b/docs/source/Setup/Installation-Git.md @@ -1,8 +1,8 @@ # Installing with GIT -This installs and runs Evennia from its sources. This is required if you want to contribute to Evennia -itself or have an easier time exploring the code. See the basic [Installation](./Installation.md) for -a quick installation of the library. See the [troubleshooting](./Installation-Troubleshooting.md) if you run +This installs and runs Evennia from its sources. This is required if you want to contribute to Evennia +itself or have an easier time exploring the code. See the basic [Installation](./Installation.md) for +a quick installation of the library. See the [troubleshooting](./Installation-Troubleshooting.md) if you run into trouble. ```{important} @@ -14,6 +14,12 @@ If you are converting an existing game from a previous version, [see here](./Ins For the impatient. If you have trouble with a step, you should jump on to the more detailed instructions for your platform. +```{warning} +Currently, these instructions will install 'latest' (stable) Evennia, which is +the 0.9.5 version. To install 1.0-dev, you need to add a step `git checkout develop` between steps +3 and 4 below. +``` + 1. Install Python, GIT and python-virtualenv. Start a Console/Terminal. 2. `cd` to some place you want to do your development (like a folder `/home/anna/muddev/` on Linux or a folder in your personal user directory on Windows). @@ -25,7 +31,7 @@ more detailed instructions for your platform. 8. `cd mygame` 9. `evennia migrate` 10. `evennia start` (make sure to make a superuser when asked) - + Evennia should now be running and you can connect to it by pointing a web browser to `http://localhost:4001` or a MUD telnet client to `localhost:4000` (use `127.0.0.1` if your OS does not recognize `localhost`). @@ -99,12 +105,12 @@ Next you can continue initializing your game from the regular [Installation inst The Evennia server is a terminal program. Open the terminal e.g. from *Applications->Utilities->Terminal*. [Here is an introduction to the Mac terminal](https://blog.teamtreehouse.com/introduction-to-the-mac-os-x-command-line) -if you are unsure how it works. +if you are unsure how it works. -* Python should already be installed but you must make sure it's a high enough version - go for +* Python should already be installed but you must make sure it's a high enough version - go for 3.10. ([This](https://docs.python-guide.org/en/latest/starting/install/osx/) discusses - how you may upgrade it). + how you may upgrade it). * GIT can be obtained with [git-osx-installer](https://code.google.com/p/git-osx-installer/) or via MacPorts [as described here](https://git-scm.com/book/en/Getting-Started-Installing-Git#Installing-on-Mac). @@ -133,7 +139,7 @@ Python practice to install into a _virtualenv_. If you are unsure about what a virtualenv is and why it's useful, see the [Glossary entry on virtualenv](../Glossary.md#virtualenv). ``` -python3.10 -m venv evenv +python3.10 -m venv evenv ``` A new folder `evenv` will appear (we could have called it anything). This folder will hold a self-contained setup of Python packages without interfering @@ -221,7 +227,7 @@ Python practice to install into a _virtualenv_. If you are unsure about what a virtualenv is and why it's useful, see the [Glossary entry on virtualenv](../Glossary.md#virtualenv). ``` -python3.10 -m venv evenv +python3.10 -m venv evenv ``` A new folder `evenv` will appear (we could have called it anything). This folder will hold a self-contained setup of Python packages without interfering @@ -251,4 +257,4 @@ pip install -e evennia Test that you can run the `evennia` command everywhere while your virtualenv (evenv) is active. -Next you can continue initializing your game from the regular [Installation instructions](./Installation.md). \ No newline at end of file +Next you can continue initializing your game from the regular [Installation instructions](./Installation.md). diff --git a/docs/source/Setup/Settings-Default.md b/docs/source/Setup/Settings-Default.md index a48451b8ad..0cc21d3be7 100644 --- a/docs/source/Setup/Settings-Default.md +++ b/docs/source/Setup/Settings-Default.md @@ -172,7 +172,8 @@ HTTP_LOG_FILE = os.path.join(LOG_DIR, "http_requests.log") LOCKWARNING_LOG_FILE = os.path.join(LOG_DIR, "lockwarnings.log") # Number of lines to append to rotating channel logs when they rotate CHANNEL_LOG_NUM_TAIL_LINES = 20 -# Max size (in bytes) of channel log files before they rotate +# Max size (in bytes) of channel log files before they rotate. +# Minimum is 1000 (1kB) but should usually be larger. CHANNEL_LOG_ROTATE_SIZE = 1000000 # Unused by default, but used by e.g. the MapSystem contrib. A place for storing # semi-permanent data and avoid it being rebuilt over and over. It is created