wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Fix continuserv instructions

Browse source 
As per f04b17f1c9

Also dedup continuserv readme
This commit is contained in:
Richard van der Hoff 2018-05-30 09:42:56 +01:00
parent 34090b24c4
commit 419bf1e52c
3 changed files with 8 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

10
README.rst
View file

@ -68,10 +68,10 @@ Windows users
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
If you're on Windows Vista or higher, be sure that the "Symbolic Links" If you're on Windows Vista or higher, be sure that the "Symbolic Links"
option was selected when installing Git prior to cloning this repository. If option was selected when installing Git prior to cloning this repository. If
you're still seeing errors about files not being found it is likely because you're still seeing errors about files not being found it is likely because
the symlink at ``api/client-server/definitions/event-schemas`` looks like a the symlink at ``api/client-server/definitions/event-schemas`` looks like a
file. To correct the problem, open an Administrative/Elevated shell in your file. To correct the problem, open an Administrative/Elevated shell in your
cloned matrix-doc directory and run the following:: cloned matrix-doc directory and run the following::
cd api\client-server\definitions cd api\client-server\definitions
@ -121,7 +121,7 @@ changes.
It is written in Go, so you will need the ``go`` compiler installed on your It is written in Go, so you will need the ``go`` compiler installed on your
computer. You will also need to install fsnotify by running:: computer. You will also need to install fsnotify by running::
go get gopkg.in/fsnotify.v1 go get gopkg.in/fsnotify/fsnotify.v1
Then, create a virtualenv as described above under `Preparation`_, Then, create a virtualenv as described above under `Preparation`_,
and:: and::

6
scripts/continuserv/README
View file

@ -1,6 +0,0 @@
continuserv proactively re-generates the spec on filesystem changes, and serves it over HTTP.
To run it, you must install the `go` tool. You will also need to install fsnotify by running:
`go get gopkg.in/fsnotify/fsnotify.v1`
You can then run continuserv by running:
`go run main.go`

3
scripts/continuserv/README.md Normal file
View file

@ -0,0 +1,3 @@
continuserv proactively re-generates the spec on filesystem changes, and serves
it over HTTP. For notes on using it, see [the main
readme](../../README.rst#continuserv).