Skip to content
This repository was archived by the owner on Nov 24, 2019. It is now read-only.

Commit 4434773

Browse files
authored
Merge pull request #4 from ismangil/docs
README edits
2 parents 8fb76fc + 453707d commit 4434773

1 file changed

Lines changed: 8 additions & 8 deletions

File tree

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Allows you to control your 3D Printer, like you can do with any [TFT/LCD panel](
1111

1212
<img width="480" src="https://user-images.githubusercontent.com/1573114/33559609-a73a969e-d90d-11e7-9cf2-cf212412aaa5.png" />
1313

14-
### Those are some of the functionalities supported:
14+
### These are some of the functionalities supported:
1515

1616
- Print jobs monitoring.
1717
- Temperature and Filament management.
@@ -34,10 +34,10 @@ in my 3d printer.
3434
Installation
3535
------------
3636

37-
### Depedencies
37+
### Dependencies
3838

3939
*OctoPrint-TFT* is based on [Golang](golang.org), usually this means that is
40-
dependency less, but in this cases [GTK+3](https://developer.gnome.org/gtk3/3.0/gtk.html)
40+
dependency-less, but in this case [GTK+3](https://developer.gnome.org/gtk3/3.0/gtk.html)
4141
is used, this means that GTK+3 libraries are required to be installed on
4242
the system.
4343

@@ -48,7 +48,7 @@ be installed using:
4848
sudo apt-get install libgtk-3-0
4949
```
5050

51-
### Installation Raspbian/OctoPi (recomened)
51+
### Installation on Raspbian/OctoPi (recommended)
5252

5353
The recommended way to install *OctoPrint-TFT* is use the `.deb` packages
5454
from the [Releases](https://github.com/mcuadros/OctoPrint-TFT/releases) page. The packages
@@ -65,7 +65,7 @@ For example for a Raspbian Jessie:
6565
### Install from source
6666

6767
The compilation and packaging tasks are managed by the [`Makefile`](Makefile)
68-
and backed on [Docker](Dockerfile). Docker is used to avoid install any other
68+
and backed on [Docker](Dockerfile). Docker is used to avoid installing any other
6969
dependencies since all the operations are done inside of the container.
7070

7171
If you need to install docker inside `Raspbian` or any other linux distrubution
@@ -78,7 +78,7 @@ sh get-docker.sh
7878

7979
> You can read more about this at [`docker-install`](https://github.com/docker/docker-install)
8080
81-
To compile the project, assuming that your already cloned this repository, just
81+
To compile the project, assuming that you already cloned this repository, just
8282
execute the `build` target, this will generate in `build` folder all the binaries
8383
and debian packages:
8484

@@ -95,12 +95,12 @@ Configuration
9595

9696
### Basic Configuration
9797

98-
The basic configuration is handle via environment variables, if your are using
98+
The basic configuration is handled via environment variables, if you are using
9999
the `.deb` package you can configure it at `/etc/octoprint-tft-environment`.
100100

101101
- `OCTOPRINT_HOST` - OctoPrint HTTP address, default `http://localhost`
102102
- `OCTOPRINT_APIKEY` - OctoPrint-TFT expects an [API key]( http://docs.octoprint.org/en/master/api/general.html) to be supplied. This API key can be either the globally configured one or a user specific one if “Access Control”.
103-
- `OCTOPRINT_CONFIG_FILE` - Location of the OctoPrint's config.yaml file, if `OCTOPRINT_APIKEY` is empty a the gobal API will be read from the config file. If empty the file will be search at the `pi` home folder or the current user.
103+
- `OCTOPRINT_CONFIG_FILE` - Location of the OctoPrint's config.yaml file, if `OCTOPRINT_APIKEY` is empty a the global API key will be read from the config file. If empty the file will be searched at the `pi` home folder or the current user.
104104
- `OCTOPRINT_TFT_STYLE_PATH` - Several themes are supported, and style configurations can be done through CSS. This variable defines the location of the application theme.
105105

106106
### Custom controls and commands

0 commit comments

Comments
 (0)