From c312c2fb8d861de301977f535b87a9be3aa96569 Mon Sep 17 00:00:00 2001 From: Aldabra Date: Tue, 13 Apr 2021 09:58:38 +0100 Subject: [PATCH] Proof-read --- README.md | 6 +++--- docs/advanced.md | 2 +- docs/build.rst | 4 ++-- docs/dev.md | 16 ++++++++-------- docs/install.md | 2 +- docs/user.md | 14 +++++++------- 6 files changed, 22 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 01e42392..00226824 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ This means that with Otter: * Supporting a new game, that Otter doesn't know about yet, would usually not involve writing or modifying any computer programs. - * If Otter already has the necessarily game elements (cards, say) all + * If Otter already has the necessary game elements (cards, say) all you need to do is write a spec file saying what should be on the table at the start of the game. For example, most Whist variants that start with a standard pack of 52 cards are already playable. @@ -47,7 +47,7 @@ You will need to be able to talk to your friends about the game, while you play. Otter works well when used together with a voice chat - we have had success with Jitsi in voice-only mode. -Most relatively modern desktop browsers should to work with Otter. +Most relatively modern desktop browsers should be able to work with Otter. (The most advanced feature needed is support for WebAssembly.) @@ -110,7 +110,7 @@ I would love contributions, particularly to address the limitations I mention above, and to improve the user experience. I am also working to make it possible to let users define their own -games (including thier own pieces, cards, boards, and so on) without +games (including their own pieces, cards, boards, and so on) without having to install them on the server. The Otter software project is hosted on Debian's GitLab, at diff --git a/docs/advanced.md b/docs/advanced.md index 4517c383..fe06e290 100644 --- a/docs/advanced.md +++ b/docs/advanced.md @@ -4,7 +4,7 @@ Advanced usage Adding pieces to a game in progress ----------------------------------- -Use the `otter library-list` and `otter library-add` commands, you can +Using the `otter library-list` and `otter library-add` commands, you can add pieces to a game while it is in progress. You may want to refer to the shape library preview ("Shapelib" link in diff --git a/docs/build.rst b/docs/build.rst index 1d5cca80..6e2953a3 100644 --- a/docs/build.rst +++ b/docs/build.rst @@ -39,7 +39,7 @@ Setup rustup default nightly rustup target add wasm32-unknown-unknown - Unfortunately, it is possible that the Rust nightly you find when + Unfortunately, it is possible that the Rust Nightly you find when you run this is missing some pieces. The following is known to work (with otter from the time of writing):: @@ -162,7 +162,7 @@ cross-browser way to puppet a browser. There is a thing called for the same purpose, called "Marionette". (In practice all this seems to have lots of bugs and misfeatures.) -AFAICT the usual approach for using geckodriver to have it *bind to +AFAICT the usual approach for using geckodriver is to have it *bind to a fixed TCP port accessible to all local programs*. My wrapper tooling arranges to run this in an ephemeral $HOME and a private network namespace. diff --git a/docs/dev.md b/docs/dev.md index 09e64039..e2ef5573 100644 --- a/docs/dev.md +++ b/docs/dev.md @@ -40,7 +40,7 @@ Resetting/restoring things after tests, updating server, etc. After the server is updated, you can just `^C` and restart it. Games are constantly saved (although there is an up-to-1s lag on the most -frequently udpated game state). +frequently updated game state). If you want to clear out the server state, delete the files `[ag]-*` and `accounts`. NB that you should do this with the server not @@ -62,10 +62,10 @@ modified server without offering your users its source code. See LICENCE. If you Do Something to the output from cargo, you should `rm stamp/*`, -since the `Makefile` won't notice, otherwise, that, the relevant cargo +since the `Makefile` won't notice, otherwise, that the relevant cargo rune(s) need to be re-run. Needlessly deleting all the stamp files wastes only a handful of seconds (on my stupidly fast laptop). -Deleting the xtamp files is not needed if you simpl edit Rust source +Deleting the xtamp files is not needed if you simply edit Rust source files. @@ -87,7 +87,7 @@ Navigating the otter source code * `daemon/` The Otter server. This is a simple binary crate. Much - functionality belonging primarily, or only, to the server, is in + functionality belonging primarily, or only, to the server is in `src/`, simply because it was easier not to disentangle it. Anything that needs Rocket (the web framework) is in `daemon/`. @@ -95,7 +95,7 @@ Navigating the otter source code Code shared by the host and the WebAssembly. Notably, the Z coordinate handling, but also a a few other minor functions needed - by both client and server. To avoid duplicating them are written + by both client and server. To avoid duplicating they are written once in Rust and compiled twice - once for the host and once for WebAssembly for use in the client. This crate is kept fairly small to keeep the WebAssembly binary small (currently, ~100kby). @@ -122,7 +122,7 @@ Navigating the otter source code * `nwtemplates/` - "Non-web templataes". Tera templates for things other than web + "Non-web templates". Tera templates for things other than web pages. Currently this includes the server's outgoing emails. These have to be in a separate directory because Tera (invoked by Rocket) likes to load everything applicable it finds in its own `templates/` @@ -158,7 +158,7 @@ Navigating the otter source code The program `./media-scraper` (which is not run by the `Makefile`) reads `library/*.toml` for instructions and generates `files.make` fragments. These fragments arrange to run `./usvg-processor` which - launders SVGs through `usvg`. `usvg-processor`. + launders SVGs through `usvg`. The shape libraries have a different, more relaxed, copyright licence. @@ -197,5 +197,5 @@ and then play with it at these urls: http://localhost:8000/?ccg9kzoTh758QrVE1xMY7BQWB36dNJTx ``` -(Yes, those are a fixed game access links, hardcoded by the tests. +(Yes, those are fixed game access links, hardcoded by the tests. You can bookmark them.) diff --git a/docs/install.md b/docs/install.md index cfdee203..394ebbb5 100644 --- a/docs/install.md +++ b/docs/install.md @@ -16,7 +16,7 @@ get at least a list of fields by looking at the Rustdoc-generated "API doc" for the type `otter::config::ServerConfigSpec`, which is probably in `target/doc/otter/config/struct.ServerConfigSpec.html`. -Here a copy of the config file from chiark. As you can see I am +Here is a copy of the config file from chiark. As you can see I am running Otter as an "application server". My usual Apache configuration handles the TLS. (Rocket's TLS is not advertised as being suitable for production use.) diff --git a/docs/user.md b/docs/user.md index 38543ce4..653e5f2c 100644 --- a/docs/user.md +++ b/docs/user.md @@ -11,8 +11,8 @@ To join a game, you run a command like this on the server host: game owner game name ``` -Tbis will print a URL. You cut and paste that URL into your browser. -It is not usually necessary to expliitly leave a game, although +This will print a URL. You cut and paste that URL into your browser. +It is not usually necessary to explicitly leave a game, although a `leave-game` subcommand is available. You can have the same URL open in multiple browsers if you wish. The @@ -45,7 +45,7 @@ Keyboard commands and special functions Otter makes use of keyboard commands for many functions. The UI will display a list of the currently-valid keyboard commands. Note that -the set of valid command can depend on what you have selected, and +the set of valid commands can depend on what you have selected, and what state it is in. @@ -83,12 +83,12 @@ UI features The UI has a number of features intended to ease play of various games. It can be worth experimenting with the UI in a test game, to -see how things work. The information presented by the game interfae +see how things work. The information presented by the game interface itself is meant as prompts and hints rather than full documentation. Notable features you might otherwise overlook include these: -Pressuing "h" repeatedly cycles through various amounts of history +Pressing "h" repeatedly cycles through various amounts of history view (the overlaid yellow arrows showing what recently happened). Typing numbers will get you into a multiple selection mode, which you @@ -148,11 +148,11 @@ This particular file says that all local shell account users may join the game. `demo` refers to the file `demo.game.spec`. The "game spec" says what -shape table is and what pieces there are. This is a simple demo game. +shape the table is and what pieces there are. This is a simple demo game. Currently there are also `penultima` and `mao` game specs. -After a game has finished and you wnat to play again, you can put +After a game has finished and you want to play again, you can put everything back to the starting state (or, even, the starting state for a different game) with something like this: -- 2.30.2