Skip to content

Commit

Permalink
Consistently use "sentence case" style
Browse files Browse the repository at this point in the history
Try to be more consistent in how we capitalize things. Both the "Title
Case" and "Sentence case" styles are popular, so either would work.
Google and Mozilla both prefer "Sentence case", so let's follow them.
  • Loading branch information
CendioOssman committed Nov 27, 2024
1 parent 2463ccd commit 7f5b51a
Show file tree
Hide file tree
Showing 67 changed files with 175 additions and 175 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ about: Create a report to help us improve
**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
**To reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
Expand Down
2 changes: 1 addition & 1 deletion LICENSE.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
noVNC is Copyright (C) 2022 The noVNC Authors
noVNC is Copyright (C) 2022 The noVNC authors
(./AUTHORS)

The noVNC core library files are licensed under the MPL 2.0 (Mozilla
Expand Down
44 changes: 22 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## noVNC: HTML VNC Client Library and Application
## noVNC: HTML VNC client library and application

[![Test Status](https://github.com/novnc/noVNC/workflows/Test/badge.svg)](https://github.com/novnc/noVNC/actions?query=workflow%3ATest)
[![Lint Status](https://github.com/novnc/noVNC/workflows/Lint/badge.svg)](https://github.com/novnc/noVNC/actions?query=workflow%3ALint)
Expand All @@ -14,19 +14,19 @@ Many companies, projects and products have integrated noVNC including
[OpenNebula](http://opennebula.org/),
[LibVNCServer](http://libvncserver.sourceforge.net), and
[ThinLinc](https://cendio.com/thinlinc). See
[the Projects and Companies wiki page](https://github.com/novnc/noVNC/wiki/Projects-and-companies-using-noVNC)
[the Projects and companies wiki page](https://github.com/novnc/noVNC/wiki/Projects-and-companies-using-noVNC)
for a more complete list with additional info and links.

### Table of Contents
### Table of contents

- [News/help/contact](#newshelpcontact)
- [Features](#features)
- [Screenshots](#screenshots)
- [Browser Requirements](#browser-requirements)
- [Server Requirements](#server-requirements)
- [Quick Start](#quick-start)
- [Installation from Snap Package](#installation-from-snap-package)
- [Integration and Deployment](#integration-and-deployment)
- [Browser requirements](#browser-requirements)
- [Server requirements](#server-requirements)
- [Quick start](#quick-start)
- [Installation from snap package](#installation-from-snap-package)
- [Integration and deployment](#integration-and-deployment)
- [Authors/Contributors](#authorscontributors)

### News/help/contact
Expand Down Expand Up @@ -86,7 +86,7 @@ See more screenshots
[here](http://novnc.com/screenshots.html).


### Browser Requirements
### Browser requirements

noVNC uses many modern web technologies so a formal requirement list is
not available. However these are the minimum versions we are currently
Expand All @@ -95,7 +95,7 @@ aware of:
* Chrome 89, Firefox 89, Safari 15, Opera 75, Edge 89


### Server Requirements
### Server requirements

noVNC follows the standard VNC protocol, but unlike other VNC clients it does
require WebSockets support. Many servers include support (e.g.
Expand All @@ -107,7 +107,7 @@ use a WebSockets to TCP socket proxy. noVNC has a sister project
proxy.


### Quick Start
### Quick start

* Use the `novnc_proxy` script to automatically download and start websockify, which
includes a mini-webserver and the WebSockets proxy. The `--vnc` option is
Expand All @@ -124,23 +124,23 @@ proxy.
script. Hit the Connect button, enter a password if the VNC server has one
configured, and enjoy!

### Installation from Snap Package
Running the command below will install the latest release of noVNC from Snap:
### Installation from snap package
Running the command below will install the latest release of noVNC from snap:

`sudo snap install novnc`

#### Running noVNC from Snap Directly
#### Running noVNC from snap directly

You can run the Snap-package installed novnc directly with, for example:
You can run the snap package installed novnc directly with, for example:

`novnc --listen 6081 --vnc localhost:5901 # /snap/bin/novnc if /snap/bin is not in your PATH`

If you want to use certificate files, due to standard Snap confinement restrictions you need to have them in the /home/\<user\>/snap/novnc/current/ directory. If your username is jsmith an example command would be:
If you want to use certificate files, due to standard snap confinement restrictions you need to have them in the /home/\<user\>/snap/novnc/current/ directory. If your username is jsmith an example command would be:

`novnc --listen 8443 --cert ~jsmith/snap/novnc/current/self.crt --key ~jsmith/snap/novnc/current/self.key --vnc ubuntu.example.com:5901`

#### Running noVNC from Snap as a Service (Daemon)
The Snap package also has the capability to run a 'novnc' service which can be
#### Running noVNC from snap as a service (daemon)
The snap package also has the capability to run a 'novnc' service which can be
configured to listen on multiple ports connecting to multiple VNC servers
(effectively a service runing multiple instances of novnc).
Instructions (with example values):
Expand Down Expand Up @@ -172,7 +172,7 @@ services.n6082.listen 6082
services.n6082.vnc localhost:5902
```

Disable a service (note that because of a limitation in Snap it's currently not
Disable a service (note that because of a limitation in snap it's currently not
possible to unset config variables, setting them to blank values is the way
to disable a service):

Expand All @@ -189,7 +189,7 @@ services.n6082.listen
services.n6082.vnc
```

### Integration and Deployment
### Integration and deployment

Please see our other documents for how to integrate noVNC in your own software,
or deploying the noVNC application in production environments:
Expand All @@ -212,8 +212,8 @@ that list and you think you should be, feel free to send a PR to fix that.
* [Solly Ross](https://github.com/DirectXMan12) (Red Hat / OpenStack)

* Notable contributions:
* UI and Icons : Pierre Ossman, Chris Gordon
* Original Logo : Michael Sersen
* UI and icons : Pierre Ossman, Chris Gordon
* Original logo : Michael Sersen
* tight encoding : Michael Tinglof (Mercuri.ca)
* RealVNC RSA AES authentication : USTC Vlab Team

Expand Down
2 changes: 1 addition & 1 deletion app/error-handler.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* noVNC: HTML5 VNC client
* Copyright (C) 2019 The noVNC Authors
* Copyright (C) 2019 The noVNC authors
* Licensed under MPL 2.0 (see LICENSE.txt)
*
* See README.md for usage and integration instructions.
Expand Down
4 changes: 2 additions & 2 deletions app/localization.js
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
/*
* noVNC: HTML5 VNC client
* Copyright (C) 2018 The noVNC Authors
* Copyright (C) 2018 The noVNC authors
* Licensed under MPL 2.0 (see LICENSE.txt)
*
* See README.md for usage and integration instructions.
*/

/*
* Localization Utilities
* Localization utilities
*/

export class Localizer {
Expand Down
16 changes: 8 additions & 8 deletions app/styles/base.css
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* noVNC base CSS
* Copyright (C) 2019 The noVNC Authors
* Copyright (C) 2019 The noVNC authors
* noVNC is licensed under the MPL 2.0 (see LICENSE.txt)
* This file is licensed under the 2-Clause BSD license (see LICENSE.txt).
*/
Expand Down Expand Up @@ -213,7 +213,7 @@ html {
}

/* ----------------------------------------
* Control Bar
* Control bar
* ----------------------------------------
*/

Expand Down Expand Up @@ -629,13 +629,13 @@ html {
margin-left: 1rem;
}

/* Connection Controls */
/* Connection controls */
:root:not(.noVNC_connected) #noVNC_disconnect_button {
display: none;
}

/* ----------------------------------------
* Status Dialog
* Status dialog
* ----------------------------------------
*/

Expand Down Expand Up @@ -701,7 +701,7 @@ html {
}

/* ----------------------------------------
* Connect Dialog
* Connect dialog
* ----------------------------------------
*/

Expand Down Expand Up @@ -770,7 +770,7 @@ html {
}

/* ----------------------------------------
* Server verification Dialog
* Server verification dialog
* ----------------------------------------
*/

Expand All @@ -787,7 +787,7 @@ html {
}

/* ----------------------------------------
* Password Dialog
* Password dialog
* ----------------------------------------
*/

Expand All @@ -806,7 +806,7 @@ html {


/* ----------------------------------------
* Main Area
* Main area
* ----------------------------------------
*/

Expand Down
2 changes: 1 addition & 1 deletion app/styles/input.css
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* noVNC general input element CSS
* Copyright (C) 2022 The noVNC Authors
* Copyright (C) 2022 The noVNC authors
* noVNC is licensed under the MPL 2.0 (see LICENSE.txt)
* This file is licensed under the 2-Clause BSD license (see LICENSE.txt).
*/
Expand Down
2 changes: 1 addition & 1 deletion app/ui.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* noVNC: HTML5 VNC client
* Copyright (C) 2019 The noVNC Authors
* Copyright (C) 2019 The noVNC authors
* Licensed under MPL 2.0 (see LICENSE.txt)
*
* See README.md for usage and integration instructions.
Expand Down
4 changes: 2 additions & 2 deletions app/webutil.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* noVNC: HTML5 VNC client
* Copyright (C) 2019 The noVNC Authors
* Copyright (C) 2019 The noVNC authors
* Licensed under MPL 2.0 (see LICENSE.txt)
*
* See README.md for usage and integration instructions.
Expand All @@ -27,7 +27,7 @@ export function initLogging(level) {
// the url can be requested in the following way:
// https://www.example.com#myqueryparam=myvalue&password=secretvalue
//
// Even Mixing public and non public parameters will work:
// Even mixing public and non public parameters will work:
// https://www.example.com?nonsecretparam=example.com#password=secretvalue
export function getQueryVar(name, defVal) {
"use strict";
Expand Down
2 changes: 1 addition & 1 deletion core/crypto/md5.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* noVNC: HTML5 VNC client
* Copyright (C) 2021 The noVNC Authors
* Copyright (C) 2021 The noVNC authors
* Licensed under MPL 2.0 (see LICENSE.txt)
*
* See README.md for usage and integration instructions.
Expand Down
2 changes: 1 addition & 1 deletion core/decoders/copyrect.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* noVNC: HTML5 VNC client
* Copyright (C) 2019 The noVNC Authors
* Copyright (C) 2019 The noVNC authors
* Licensed under MPL 2.0 (see LICENSE.txt)
*
* See README.md for usage and integration instructions.
Expand Down
2 changes: 1 addition & 1 deletion core/decoders/h264.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* noVNC: HTML5 VNC client
* Copyright (C) 2024 The noVNC Authors
* Copyright (C) 2024 The noVNC authors
* Licensed under MPL 2.0 (see LICENSE.txt)
*
* See README.md for usage and integration instructions.
Expand Down
2 changes: 1 addition & 1 deletion core/decoders/hextile.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* noVNC: HTML5 VNC client
* Copyright (C) 2019 The noVNC Authors
* Copyright (C) 2019 The noVNC authors
* Licensed under MPL 2.0 (see LICENSE.txt)
*
* See README.md for usage and integration instructions.
Expand Down
2 changes: 1 addition & 1 deletion core/decoders/jpeg.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* noVNC: HTML5 VNC client
* Copyright (C) 2019 The noVNC Authors
* Copyright (C) 2019 The noVNC authors
* Licensed under MPL 2.0 (see LICENSE.txt)
*
* See README.md for usage and integration instructions.
Expand Down
2 changes: 1 addition & 1 deletion core/decoders/raw.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* noVNC: HTML5 VNC client
* Copyright (C) 2019 The noVNC Authors
* Copyright (C) 2019 The noVNC authors
* Licensed under MPL 2.0 (see LICENSE.txt)
*
* See README.md for usage and integration instructions.
Expand Down
2 changes: 1 addition & 1 deletion core/decoders/rre.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* noVNC: HTML5 VNC client
* Copyright (C) 2019 The noVNC Authors
* Copyright (C) 2019 The noVNC authors
* Licensed under MPL 2.0 (see LICENSE.txt)
*
* See README.md for usage and integration instructions.
Expand Down
2 changes: 1 addition & 1 deletion core/decoders/tight.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* noVNC: HTML5 VNC client
* Copyright (C) 2019 The noVNC Authors
* Copyright (C) 2019 The noVNC authors
* (c) 2012 Michael Tinglof, Joe Balaz, Les Piech (Mercuri.ca)
* Licensed under MPL 2.0 (see LICENSE.txt)
*
Expand Down
2 changes: 1 addition & 1 deletion core/decoders/tightpng.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* noVNC: HTML5 VNC client
* Copyright (C) 2019 The noVNC Authors
* Copyright (C) 2019 The noVNC authors
* Licensed under MPL 2.0 (see LICENSE.txt)
*
* See README.md for usage and integration instructions.
Expand Down
2 changes: 1 addition & 1 deletion core/decoders/zlib.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* noVNC: HTML5 VNC client
* Copyright (C) 2024 The noVNC Authors
* Copyright (C) 2024 The noVNC authors
* Licensed under MPL 2.0 (see LICENSE.txt)
*
* See README.md for usage and integration instructions.
Expand Down
2 changes: 1 addition & 1 deletion core/decoders/zrle.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* noVNC: HTML5 VNC client
* Copyright (C) 2021 The noVNC Authors
* Copyright (C) 2021 The noVNC authors
* Licensed under MPL 2.0 (see LICENSE.txt)
*
* See README.md for usage and integration instructions.
Expand Down
2 changes: 1 addition & 1 deletion core/deflator.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* noVNC: HTML5 VNC client
* Copyright (C) 2020 The noVNC Authors
* Copyright (C) 2020 The noVNC authors
* Licensed under MPL 2.0 (see LICENSE.txt)
*
* See README.md for usage and integration instructions.
Expand Down
2 changes: 1 addition & 1 deletion core/display.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* noVNC: HTML5 VNC client
* Copyright (C) 2019 The noVNC Authors
* Copyright (C) 2019 The noVNC authors
* Licensed under MPL 2.0 (see LICENSE.txt)
*
* See README.md for usage and integration instructions.
Expand Down
2 changes: 1 addition & 1 deletion core/encodings.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* noVNC: HTML5 VNC client
* Copyright (C) 2019 The noVNC Authors
* Copyright (C) 2019 The noVNC authors
* Licensed under MPL 2.0 (see LICENSE.txt)
*
* See README.md for usage and integration instructions.
Expand Down
2 changes: 1 addition & 1 deletion core/inflator.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* noVNC: HTML5 VNC client
* Copyright (C) 2020 The noVNC Authors
* Copyright (C) 2020 The noVNC authors
* Licensed under MPL 2.0 (see LICENSE.txt)
*
* See README.md for usage and integration instructions.
Expand Down
2 changes: 1 addition & 1 deletion core/input/domkeytable.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* noVNC: HTML5 VNC client
* Copyright (C) 2018 The noVNC Authors
* Copyright (C) 2018 The noVNC authors
* Licensed under MPL 2.0 or any later version (see LICENSE.txt)
*/

Expand Down
2 changes: 1 addition & 1 deletion core/input/fixedkeys.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* noVNC: HTML5 VNC client
* Copyright (C) 2018 The noVNC Authors
* Copyright (C) 2018 The noVNC authors
* Licensed under MPL 2.0 or any later version (see LICENSE.txt)
*/

Expand Down
Loading

0 comments on commit 7f5b51a

Please sign in to comment.