Skip to content
This repository has been archived by the owner on Mar 30, 2024. It is now read-only.

Commit

Permalink
Docs for updating source installs.
Browse files Browse the repository at this point in the history
  • Loading branch information
jzohrab committed Nov 23, 2023
1 parent 23dd58c commit 15d7536
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 1 deletion.
2 changes: 2 additions & 0 deletions src/install/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,8 @@ Developers and gearheads can install Lute from source: see the [Lute repository]

If you want to develop Lute, you'll also need to [install MeCab](./mecab.md).

If you install from source and tinker with the code, make sure you can update later! See [Keeping up-to-date when installing from source](/usage/updating.md#keeping-up-to-date-when-installing-from-source).

---

[^what-is-docker]: Docker is a containerization platform that allows you to run applications in a sandboxed environment (ref the [Docker documentation](https://docs.docker.com/)). **Docker is not available or is problematic on some systems, particularly Windows.**
Expand Down
34 changes: 33 additions & 1 deletion src/usage/updating.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,36 @@ docker compose up -d --remove-orphans

## ... if using source

`git fetch` etc etc. (I assume you know what you're doing here.)
I assume you already know what you're doing, but here's a rough outline anyway:

Stop Lute.

```
git remote add upstream [email protected]:jzohrab/lute-v3.git
git fetch upstream
git merge upstream/master
```

There are other ways to do this, like PR master into your own fork, etc.

### Keeping up-to-date when installing from source

All Lute development happens on the `develop` branch in the main repo, and when launched that code is merged into `master`.

If you install from source and make any modifications to Lute -- which _of course_ you're welcome to do -- then you may want to periodically check the `develop` branch in the main Lute repo to ensure that you can merge in `master` when it is released. Here's roughly what you'd do:

```
# Commit your local changes
git add [your files]
git commit -m "[changes]"
git remote add upstream [email protected]:jzohrab/lute-v3.git
git fetch upstream
# Check commits, if you want
git log HEAD..upstream/develop --oneline
git merge upstream/develop
```

Lute source code could change at any time, and I **almost certainly will not** be able to help you resolve code conflicts. With that said, I'm certainly interested in any changes that would be beneficial to the health/clarity of the code or would be useful for others, so if you make changes that you think would be good, let me know!

0 comments on commit 15d7536

Please sign in to comment.