Fix paths in README (#6222)

This commit is contained in:
Stefan Müller 2024-03-14 16:09:34 +01:00 committed by GitHub
parent fe106f0afc
commit 7ef69d3840
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -56,7 +56,7 @@ Install the latest Node.js LTS per [official install instructions](https://githu
```sh ```sh
git clone --branch master https://github.com/ether/etherpad-lite.git && git clone --branch master https://github.com/ether/etherpad-lite.git &&
cd etherpad-lite && cd etherpad-lite &&
src/bin/run.sh bin/run.sh
``` ```
#### Manual install #### Manual install
@ -70,10 +70,10 @@ You'll need Git and [Node.js](https://nodejs.org/) installed.
https://github.com/ether/etherpad-lite.git` https://github.com/ether/etherpad-lite.git`
3. Change into the new directory containing the cloned source code: `cd 3. Change into the new directory containing the cloned source code: `cd
etherpad-lite` etherpad-lite`
4. Run `src/bin/run.sh` and open http://127.0.0.1:9001 in your browser. 4. Run `bin/run.sh` and open http://127.0.0.1:9001 in your browser.
To update to the latest released version, execute `git pull origin`. The next To update to the latest released version, execute `git pull origin`. The next
start with `src/bin/run.sh` will update the dependencies. start with `bin/run.sh` will update the dependencies.
### Windows ### Windows
@ -98,12 +98,12 @@ git.
* or `git clone --branch master * or `git clone --branch master
https://github.com/ether/etherpad-lite.git` https://github.com/ether/etherpad-lite.git`
2. With a "Run as administrator" command prompt execute 2. With a "Run as administrator" command prompt execute
`src\bin\installOnWindows.bat` `bin\installOnWindows.bat`
Now, run `start.bat` and open http://localhost:9001 in your browser. Now, run `start.bat` and open http://localhost:9001 in your browser.
Update to the latest version with `git pull origin`, then run Update to the latest version with `git pull origin`, then run
`src\bin\installOnWindows.bat`, again. `bin\installOnWindows.bat`, again.
If cloning to a subdirectory within another project, you may need to do the If cloning to a subdirectory within another project, you may need to do the
following: following:
@ -180,7 +180,7 @@ following plugins:
### Tweak the settings ### Tweak the settings
You can modify the settings in `settings.json`. If you need to handle multiple You can modify the settings in `settings.json`. If you need to handle multiple
settings files, you can pass the path to a settings file to `src/bin/run.sh` settings files, you can pass the path to a settings file to `bin/run.sh`
using the `-s|--settings` option: this allows you to run multiple Etherpad using the `-s|--settings` option: this allows you to run multiple Etherpad
instances from the same installation. Similarly, `--credentials` can be used to instances from the same installation. Similarly, `--credentials` can be used to
give a settings override file, `--apikey` to give a different APIKEY.txt file give a settings override file, `--apikey` to give a different APIKEY.txt file
@ -224,11 +224,11 @@ Documentation can be found in `doc/`.
### Things you should know ### Things you should know
You can debug Etherpad using `src/bin/debugRun.sh`. You can debug Etherpad using `bin/debugRun.sh`.
You can run Etherpad quickly launching `src/bin/fastRun.sh`. It's convenient for You can run Etherpad quickly launching `bin/fastRun.sh`. It's convenient for
developers and advanced users. Be aware that it will skip the dependencies developers and advanced users. Be aware that it will skip the dependencies
update, so remember to run `src/bin/installDeps.sh` after installing a new update, so remember to run `bin/installDeps.sh` after installing a new
dependency or upgrading version. dependency or upgrading version.
If you want to find out how Etherpad's `Easysync` works (the library that makes If you want to find out how Etherpad's `Easysync` works (the library that makes