Skip to content

Commit

Permalink
docs: grammar fixes in README
Browse files Browse the repository at this point in the history
  • Loading branch information
palmerj authored and imincik committed Feb 11, 2024
1 parent 36695bb commit 47aeff9
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# Geospatial packages repository and environment

**Geospatial NIX** provides weekly updated geospatial packages and tools built
on top of latest stable Nixpkgs branch for creating isolated and reproducible
on top of the latest stable Nixpkgs branch for creating isolated and reproducible
geospatial environments. Check out the user interface at
[https://geospatial-nix.today/](https://geospatial-nix.today/) .

Expand Down Expand Up @@ -41,7 +41,7 @@ nix flake show github:imincik/geospatial-nix

### Run applications without installation

* Launch latest stable QGIS version
* Launch the latest stable QGIS version
```bash
nix run github:imincik/geospatial-nix#qgis
```
Expand All @@ -65,7 +65,7 @@ nix run github:imincik/geospatial-nix#geonixcli init
git add *
```

* Edit `geonix.nix` file according your project requirements
* Edit `geonix.nix` file according to your project requirements
(check out [examples](examples/) for example configurations)

* Launch shell environment
Expand Down Expand Up @@ -93,12 +93,12 @@ nix build .#<PACKAGE>
nix build .#all-packages
```

* Build single package and push it to Geonix binary cache
* Build a single package and push it to the Geonix binary cache
```
nix build --json .#<PACKAGE> | jq -r '.[].outputs | to_entries[].value' | cachix push geonix
```

* Build all packages and push them to Geonix binary cache
* Build all packages and push them to the Geonix binary cache
```
nix build --json .#all-packages | jq -r '.[].outputs | to_entries[].value' | cachix push geonix
```
Expand All @@ -108,7 +108,7 @@ nix build --json .#all-packages | jq -r '.[].outputs | to_entries[].value' | ca
nix build -L .#<PACKAGE>.tests.<TEST-NAME>
```

_To re-build already built package or to re-run already succeeded tests use
_To an re-build already built package or to re-run already succeeded tests, use the
`--rebuild` switch._

### Debugging packages
Expand Down Expand Up @@ -143,7 +143,7 @@ nix why-depends .#<PACKAGE> .#<DEPENDENCY>

#### Packages update process

* Create `pkgs-weekly-update` branch and collect all packages updates
* Create a `pkgs-weekly-update` branch and collect all package updates
in this branch (Monday)
```bash
git checkout -b pkgs-weekly-update-$(date "+%Y-%U")
Expand All @@ -152,15 +152,15 @@ git checkout -b pkgs-weekly-update-$(date "+%Y-%U")
* Merge automatically created flake update PR (`flake-update-action-pr` branch)
in to `pkgs-weekly-update` branch

* Pull from latest Nixpkgs master (Thursday - Friday)
* Pull from the latest Nixpkgs master (Thursday - Friday)
```bash
utils/pull-nixpkgs.sh <NIXPKGS-DIR>
```

* Review changes, identify related PRs in Nixpkgs, split changes to separate
commits (link to Nixpks PR in commit message)

* Optional: generate reverse patch for changes which are not desired
* Optional: generate a reverse patch for changes which are not desired
```
git diff -R <CHANGED-FILE> > pkgs/<PACKAGE>/nixpkgs/<PATCH-NAME>.patch
```
Expand Down

0 comments on commit 47aeff9

Please sign in to comment.